Introduction
Overview of the Admin Panel
The admin panel serves as a centralized platform for managing various aspects of the system. It provides administrators and authorized users with access to powerful tools and functionalities to oversee and control the system's operations. Through the admin panel, users can configure settings, manage user accounts, monitor performance, analyze data, and perform various administrative tasks crucial for the smooth operation of the system.
Purpose of the Documentation
The purpose of this documentation is to provide comprehensive guidance and instructions on the usage, functionality, and administration of the admin panel. It aims to empower users, administrators, and stakeholders with the knowledge and resources necessary to effectively utilize the features of the admin panel. By offering detailed explanations, step-by-step procedures, best practices, and troubleshooting tips, this documentation strives to enhance user understanding, streamline operations, and maximize the value derived from the admin panel.
Target Audience
The primary audience for this documentation includes administrators, system operators, and technical personnel responsible for managing and maintaining the system. Additionally, it caters to users who interact with the admin panel to perform specific tasks or access certain functionalities within the system. This documentation is designed to accommodate users with varying levels of technical expertise, providing both basic instructions for beginners and advanced configurations for experienced administrators. Furthermore, stakeholders and decision-makers involved in the system's governance and strategy may also find this documentation valuable in understanding the capabilities and implications of the admin panel.
Roles and Permissions
In the context of the admin panel, roles define the level of access, permissions, and responsibilities granted to different users within the system. Each role is associated with specific privileges and limitations, ensuring that users can only perform actions relevant to their assigned tasks and responsibilities. Here's an overview of the common roles typically found in the admin panel.
Superadmin Role
The Superadmin role is a privileged position within the admin panel that grants unrestricted access and authority over various critical functions and configurations. Unlike other roles, actions performed by users assigned the Superadmin role do not require approval or the creation of tasks for decision-making.
Capabilities and Responsibilities:
Creation Permissions:
The Superadmin role allows for the creation of various entities within the system, including:
Currency creation.
Addition of new payment interfaces for currencies.
Market creation.
Workflow creation.
Role and level configuration for the referral program.
Implementation of withdrawal restriction levels.
Configuration of other essential options.
Configuration Management:
Superadmins have the authority to configure crucial settings within the system, such as:Currencies and their associated parameters.
Payment interfaces, including adding new interfaces and modifying existing ones.
Market configurations, including rate sources and other settings.
Staking conditions.
Referral program conditions.
Withdrawal restriction levels.
User Management:
Superadmins can make decisions related to user authentication and verification, such as:Verifying user KYC (Know Your Customer) information.
Updating employee permissions.
Adjusting user withdrawal restriction levels.
Transaction Operations:
The Superadmin role includes the ability to perform operations related to transactions, such as:Reviewing and approving transactions.
Modifying transaction parameters or conditions.
Updating rate sources for markets.
Comprehensive Access:
Superadmins have permissions for all available options within the admin panel, granting them comprehensive access to the system's functionalities and configurations.
The Superadmin role is designed to provide maximum flexibility and control to authorized users, allowing them to manage critical aspects of the system without constraints or delays. With the Superadmin role, individuals can efficiently oversee and administer various operations, configurations, and decisions within the admin panel, ensuring the smooth functioning and optimal performance of the system.
Requester Role
Capabilities and Responsibilities:
Edit Permissions:
The Requester role enables employees to create requests for various entities within the system, including:
Currency creation.
Addition of new payment interfaces for currencies.
Market creation.
Workflow creation.
Role and level configuration for the referral program.
Implementation of withdrawal restriction levels.
Configuration of other essential options.
Configuration Management:
Requesters can create requests to configure crucial settings within the system, such as:
Currencies and their associated parameters.
Payment interfaces, including adding new interfaces and modifying existing ones.
Market configurations, including rate sources and other settings.
Staking conditions.
Referral program conditions.
Withdrawal restriction levels.
User Management:
Employees with the Requester Role can make decisions related to user authentication and verification, including:
Verifying user KYC (Know Your Customer) information.
Updating employee permissions.
Adjusting user withdrawal restriction levels.
Transaction Operations:
The Requester role includes the ability to request to perform operations related to transactions, such as:
Reviewing and approving transactions.
Modifying transaction parameters or conditions.
Updating rate sources for markets.
Upon creation of a request by a Requester, a corresponding task is generated in the Workspace page of the admin panel. Requesters can view the main details of the request and its status following their decision-making process. This integrated workflow ensures transparency, accountability, and streamlined management of system modifications and operations.
Approver Role
Workspace Page for Approvers:
Employees assigned the Approver Role have access to the Workspace page within the Admin panel. This page serves as a centralized hub where Approvers can observe tasks awaiting their attention. The Workspace page provides essential details of each request, including its origin and pertinent information.
Main Features:
Task Overview:
Approvers can view a list of tasks awaiting their review and decision-making.
Each task is accompanied by a summary of its main details, facilitating quick analysis.
Request Details:
Approvers have access to comprehensive information regarding each request.
Key details such as the type of request, associated entities, and any relevant notes are readily available.
Request Origin:
The Workspace page displays the source of each request, allowing Approvers to identify the requester.
Decision Making:
Approvers are provided with options to either accept or reject each request.
Upon analyzing the request, Approvers can make informed decisions regarding its approval or rejection.
Benefits:
Efficient Decision-Making: Approvers can swiftly analyze requests and make timely decisions from a centralized location.
Transparency: The Workspace page provides visibility into the request process, ensuring transparency and accountability.
Streamlined Workflow: Integration with the request submission process streamlines workflow management, enhancing productivity and effectiveness.
Overall, the Workspace page serves as a crucial tool for Approvers, facilitating efficient task management and decision-making within the Admin panel.
Permissions Matrix
View Permission
This permission grants the admin access to particular information or functionalities within the system. Admins with view permission can browse through data, reports, or sections of the application, gaining insight into various aspects of the system's operations. However, they do not possess the authority to make any alterations or edits. Instead, their access is limited to viewing and analyzing the existing data or reports. This permission is crucial for admins who need to monitor the system's performance, review analytics, or access specific information without the need to modify it.
viewWithdrawalRestrictions
Permission: Grants access to view the Restrictions page, enabling administrators to review 24-hour withdrawal limits, eligibility criteria, and other relevant information without modifying settings.Main details to observe:
Level: The level of restriction or limitation imposed on users, often categorized based on factors such as account verification status or transaction volume.
Level Name: The name or label associated with each restriction level, providing clarity on the purpose or criteria of the level.
Limit (in Key Platform Currency): Specifies the withdrawal limit for each level, typically expressed in the platform's native currency.
Users (for each level): Indicates the number of users assigned to each restriction level.
Main details for each level:Icon: An optional visual representation or icon associated with each restriction level, aiding in quick identification.
Name: The name or label of the restriction level, providing descriptive information about its purpose or criteria.
Amount (in Key Platform Currency): Specifies the amount or value associated with each restriction level, often indicating the threshold for accessing certain privileges or benefits.
Rates (for markets with Key Platform Currency): Indicates the rates applicable to transactions or activities within markets using the platform's native currency.
Users (with the amount and current user's KYC step of verification): Provides information about the users assigned to each restriction level, including their assigned amount or value within the level and their current status regarding KYC (Know Your Customer) verification steps.
This permission enables administrators to monitor and manage user restrictions effectively, ensuring compliance with regulatory requirements and platform policies while maintaining transparency and security within the system.
viewKYCWaiting
Allows access to the KYC Waiting sub-menu on the Users page for administrators to review pending Know Your Customer (KYC) verifications without the ability to alter or approve submissions. The main details for KYC waiting users include:
First Name: The given or first name of the user.
Last Name: The family or last name of the user.
Birth: The date of birth of the user.
Address: The residential address of the user.
City: The city of residence of the user.
Country: The country of residence of the user.
Postcode: The postal code or ZIP code of the user's address.
Nationality: The nationality or citizenship of the user.
Document Files: Files containing documents provided by the user for KYC verification purposes, such as identification cards, passports, or utility bills.
This permission allows administrators to access the KYC Waiting sub-menu on the Users page specifically to review pending KYC verifications. By examining the main details provided for users in the pending queue, administrators can verify the accuracy and completeness of the submitted information. The listed details, including the user's name, date of birth, address, nationality, and document files, enable administrators to conduct thorough verification checks. However, administrators are unable to alter or approve submissions, ensuring the integrity and impartiality of the verification process.
viewAudit
Grants access to the Audit logs, Runtimes, and Failed Login IP sub-menu located within the Security page, enabling administrators to review system activity logs for monitoring purposes, without the capability to modify or delete audit entries.
Audit Logs: This permission allows administrators to access the audit logs section, which records various system activities and events such as user actions, configuration changes, and security-related events. Access to audit logs is crucial for monitoring system behavior and ensuring compliance with security policies and regulations.
Runtimes: The runtimes section provides information about the runtime environment of the system, including details such as system uptime, resource usage, and performance metrics. Monitoring runtimes helps administrators track system health and identify potential issues or performance bottlenecks.
Failed Login IP: This subsection within the Security page logs information about failed login attempts, including the IP addresses from which the attempts originated. Monitoring failed login attempts can help administrators detect potential security threats such as brute-force attacks or unauthorized access attempts.
viewEmployees
Grants access to the Employees sub-menu located within the Security page, enabling administrators to review employee accounts and roles without the ability to modify or create/delete employee information. Additionally, provides access to view employees' emails, the count of roles for each employee, and the assigned roles.Administrators can view the following details for each employee:
Employee Emails: The email addresses associated with each employee's account, provide a unique identifier for communication and login purposes.
Count of Roles for Each Employee: Specifies the number of roles assigned to each employee. This count helps administrators understand the level of access and permissions granted to individual employees within the system.
Assigned Roles: Lists the roles assigned to each employee, detailing the specific permissions and responsibilities associated with each role. By reviewing assigned roles, administrators can ensure that employees have appropriate access levels to perform their duties effectively.
viewReferralProgram
Grants access to the Referrals page, allowing administrators to review details, statistics, and settings related to the referral program without the ability to modify or alter its configurations. This access includes:Trade Groups Sub-menu: Administrators can review the main details of each trade group, including the name, description, and reward percentage by level.
Deposit Groups Sub-menu: Administrators can review the main details of each deposit group, such as the name, description, and rewards percentage by levels, similar to the trade groups.
Users Sub-menu: Administrators can review the main details of users participating in the referral program, including:
Email: The email address of the user.
Referral Info: Information related to the user's referrals.
Referral Code: The unique referral code assigned to the user.
Parent: The parent user who referred the current user.
Referral Group: The group to which the user belongs within the referral program.
Referral OTP Group: The OTP (One-Time Password) group is associated with the user's referrals.
Referral Children: The children users are referred by the current user.
Level: The level of the user within the referral program.
Referrals: The number of users referred by the current user.
Children Count. The count of children users referred by the current user.
Referrals Children: The children users are referred by the current user.
This permission provides administrators with comprehensive access to the Referrals page, allowing them to analyze various aspects of the referral program. Administrators can review trade groups and deposit groups, examining their details and rewards structures. Additionally, administrators can access user information within the referral program, including their referral details, groups, and relationships with other users. This access enables administrators to effectively monitor and manage the referral program's performance and participant activities without altering its configurations.
viewStaking
Grants access to the staking page, enabling administrators to review several sub-menus:User Staking Sub-menu: Provides the option to observe active and closed staking operations details for users.
Rewards Sub-menu: Offers the option to observe staking rewards operations details.
Users Unstaking Sub-menu: Allows administrators to observe staking operations details that are in the pending unstaking process.
Currencies Sub-menu: Allows administrators to observe the list of available currencies and their staking-enabled status. In the currency details, administrators can review configurations for staking, including:
Name: The name or identifier of the currency.
User Balance Enabled Status: Indicates whether the user balance feature is enabled for the currency.
Precision: Refers to the number of decimal places used to represent fractional amounts of the currency.
Position: Determines the position of the currency symbol relative to the numerical value.
Icon URL: Provides the URL link to the icon or image representing the currency.
Timestamp of Created At/Updated: Indicates the timestamps for when the currency configuration was created and last updated.
Staking Enabled Status: Indicates whether staking is enabled for the currency.
Staking APR (Annual Percentage Rate): Specifies the annual percentage rate of return for staking the currency.
Min Staking Amount: Specifies the minimum amount required for staking.
Instant Unstaking Enabled Status: Indicates whether instant unstaking is enabled for the currency.
Staking Period: Specifies the duration for which the currency needs to be staked to earn rewards.
Timestamp of the Last Staking Calculation: Indicates the timestamp of the last staking calculation performed.
This permission provides administrators with comprehensive access to manage and monitor staking-related operations and configurations, ensuring efficient management of staking activities and rewards within the system.
viewSoftban
Grants access to the Softban sub-menu located within the Security page, enabling administrators to review Softban settings and configurations without the ability to modify them. Additionally, allows access to the Soft banned sub-menu located within the Users page, enabling administrators to review Softban users and their details without the ability to modify them.Softban Sub-menu Access (Security Page): This permission enables administrators to access the Softban sub-menu within the Security page. In this sub-menu, administrators can review Softban settings and configurations, including parameters related to temporary restrictions or limitations placed on users or specific activities. However, administrators cannot modify these settings, ensuring the stability and consistency of the Softban configurations.
Soft Banned Sub-menu Access (Users Page): Additionally, administrators are granted access to the Soft Banned Sub-menu within the Users page. In this sub-menu, administrators can review a list of users who have been Softbanned along with their details. This includes information such as usernames, account IDs, and any relevant details associated with the Softban status. However, administrators do not possess the capability to modify or alter the Softban status of users, maintaining the integrity and fairness of the Softban system.
These permissions provide administrators with the necessary access to monitor Softban settings, configurations, and affected users within the system. By allowing administrators to review Softban-related information without the ability to modify it, these permissions help ensure consistent enforcement of Softban policies while preventing unauthorized changes to user statuses.
viewUserGeneral
Grants access to the user general submenu within individual user details on the Users page, enabling administrators to review general information and settings associated with Main info of User Email, Status, Enabled 2FA, Soft ban, Withdrawal Restriction Level, Email verification, Phone verification, and Profile verification. Overall, this permission provides administrators with the necessary access to review crucial user information and settings, ensuring compliance, security, and effective account management within the system.viewMarkets
Permission: Grants access to the Markets sub-menu within the Configurations page, enabling administrators to review market-related settings without the ability to modify or alter them. The settings include:General Market Information:
ID: Unique identifier for the market.
Base Currency: Currency used as the base in trading pairs.
Quote Currency: Currency used as the quote in trading pairs.
Min Base Currency Amount: Minimum amount allowed for base currency transactions.
Min Quote Currency Amount: Minimum amount allowed for quote currency transactions.
Commission Currency: Currency used for trading commissions.
Swap Quote->Base Price Precision: Precision level for swapping quote currency to base currency.
Swap Base->Quote Price Precision: Precision level for swapping base currency to quote currency.
Trading Settings:
Enabled Status: Status indicating if trading is enabled for the market.
Trading Bot Status: Status indicating if a trading bot is active for the market.
Market Position: Position of the market.
Amount Precision: Precision level for amount values in trading.
Minimum Amount: Minimum amount allowed for trading.
Price Precision: Precision level for price values in trading.
Minimum Price: Minimum price allowed for trading.
Maximum Price: Maximum price allowed for trading.
Maker Fee (%): Percentage maker fee applied to transactions.
Taker Fee (%): Percentage taker fee applied to transactions.
Swap Types Statuses:
On-Chain Swap Enabled: Status indicating if on-chain swapping is enabled.
Off-Chain Swap Enabled: Status indicating if off-chain swapping is enabled.
Chain-In Swap Enabled: Status indicating if chain-in swapping is enabled.
Chain-Out Swap Enabled: Status indicating if chain-out swapping is enabled.
Swap Commission Details:
Quote->Base (%): Percentage commission for quote currency to base currency swaps.
Quote->Base (Minimum): Minimum commission for quote currency to base currency swaps.
Quote->Base (Maximum): Maximum commission for quote currency to base currency swaps.
Base->Quote (%): Percentage commission for base currency to quote currency swaps.
Base->Quote (Minimum): Minimum commission for base currency to quote currency swaps.
Base->Quote (Maximum): Maximum commission for base currency to quote currency swaps.
These permissions allow administrators to review comprehensive details and configurations related to markets, including trading settings, swap types statuses, and commission details, facilitating effective management and monitoring of market activities.
viewStatistics
These permissions provide administrators with the necessary access to monitor the General sub-menu on the Dashboard page, including the following main information:New Users:
Total number of new users.
New users registered within the current month.
New users registered within the current week.
New users registered within the current day.
New Visits:
Total number of new visits.
New visits were recorded within the current month.
New visits were recorded within the current week.
New visits were recorded within the current day.
User Actions:
Total number of user operations.
User operations recorded within the last 24 hours.
Trading queue status.
In addition, administrators are granted access to observe Rated liabilities and assets as well as Unrated liabilities and assets of the platform. This access enables administrators to analyze:
Liabilities: Total rated and unrated liabilities of the platform.
Assets: Total rated and unrated assets of the platform.
Profit for related currency: Allows for analysis of profit generated for each related currency.
These permissions empower administrators to effectively monitor key metrics related to user activity, site visits, and platform assets and liabilities. By having access to this information, administrators can make informed decisions and adjustments to optimize platform performance and ensure regulatory compliance.
viewUserTracking
Grants access to the tracking submenu within individual user details on the Users page, enabling administrators to review tracking information and activity associated with user accounts, without the ability to modify or alter this data. The tracking information includes:
Login Date: This indicates the date and time of the user's last login activity within the system.
User IP Address: Provides the IP address from which the user accessed the system during their last login session. The IP address serves as a unique identifier for the user's device or network connection.
User Agent: Refers to the user agent string sent by the user's web browser or client application during the login session. It typically includes details about the browser or application version, operating system, and device type used by the user.
User Platform: Specifies the platform or environment from which the user accessed the system, such as desktop, mobile, or tablet.
This permission allows administrators to track and monitor user activity within the system by reviewing login dates, IP addresses, user agents, and platforms. It helps administrators identify suspicious login attempts, track user behavior patterns, and ensure the security and integrity of user accounts without the ability to modify or alter the tracking data..
viewUserAccounting
Grants access to view the main details of users for Balances (including accounting details), Wallets, External Wallets, and Recipients submenus on the Users page. This enables administrators to review financial transactions and accounting information associated with user accounts without the ability to modify or alter this data. Additionally, it allows access to view the User's Generated proxy wallets, the User's connected External wallets, and the User's recipients that were created during withdrawal.viewBlockchains
This permission grants access to the blockchains sub-menu within the Configurations page, enabling administrators to review settings related to blockchain integration, configurations, or network parameters without the ability to modify or alter them. Administrators can review:
Name: The name of the blockchain.
Height Parameter: The parameter indicating the current height of the blockchain.
ChainId: The unique identifier for the blockchain.
Explorer: The address of the blockchain explorer.
Connected Blockchain: The blockchain is connected to the system.
MinConfirmations: The minimum number of confirmations required for transactions on the blockchain.
Wallet: The wallet associated with the blockchain.
Currencies That Connected: The currencies connected to the blockchain.
viewWorkflows
Grants access to the workflows sub-menu within the Configurations page, enabling administrators to review existing workflows, without the ability to modify or alter them. Administrators can also observe Workflow instances categorized into Running and Finished states.
Additionally, administrators can observe Workflow instances, which are categorized into two states:
Running: Refers to workflow instances that are currently active and in progress.
Finished: Indicates workflow instances that have been completed.
viewSystemHealth
Grants access to the System Health sub-menu within the Dashboard page, allowing administrators to monitor and review the overall health and performance metrics of the system without the ability to modify or alter these settings.viewExchangeRates
Grants access to the Exchange rates sub-menu within the Configurations page, enabling administrators to review settings related to market exchange rates without the ability to modify or alter them.viewCurrencies
Grants access to the currencies sub-menu within the Configurations page, enabling administrators to review settings related to currencies, such as:Name: This indicates the name or identifier of the currency, such as USD, BTC, ETH, etc.
User Balance Enabled Status: Specifies whether the user balance feature is enabled for the currency. When enabled, users can hold balances in this currency within the system.
Precision: Refers to the number of decimal places used to represent fractional amounts of the currency.
Position: Determines the position of the currency symbol relative to the numerical value (e.g., before or after the number).
Icon URL: Provides the URL link to the icon or image representing the currency, often used for visual identification purposes.
Timestamps (Created At/Updated): Indicates the timestamps for when the currency configuration was created and last updated.
Light Theme Colors: Specifies the color scheme used for displaying the currency details in a light-themed interface.
Dark Theme Colors: Specifies the color scheme used for displaying the currency details in a dark-themed interface.
Enabled Status: Indicates whether the currency is currently enabled and available for use within the system.
Hidden Status: Specifies whether the currency is hidden or not displayed to users within the system interface.
Trading Commission Enabled Status: Indicates whether trading commissions are enabled for transactions involving this currency.
Payout Platform Commission: Specifies the commission or fee charged by the platform for payouts or withdrawals made in this currency.
This permission allows administrators to access and review various settings and configurations related to currencies within the system, providing them with the necessary tools to manage and customize currency-related functionalities according to the platform's requirements and user needs.
viewUserKYC
Grants access to the KYC (Know Your Customer) sub-menu within individual user details on the Users page, enabling administrators to review KYC information and verification statuses associated with specific user accounts without the ability to modify or alter them. The permission allows reviewing the main information about the user, including:
First Name: The given or first name of the user.
Last Name: The family or last name of the user.
Birth: The date of birth of the user.
Address: The residential address of the user.
City: The city of residence of the user.
Country: The country of residence of the user.
Postcode: The postal code or ZIP code of the user's address.
Nationality: The nationality or citizenship of the user.
Document Files: Files containing documents provided by the user for KYC verification purposes, such as identification cards, passports, or utility bills.
This permission allows administrators to access and review essential KYC information and verification statuses associated with individual user accounts. By examining details such as the user's name, date of birth, address, and nationality, administrators can ensure compliance with regulatory requirements and verify the identity of users on the platform. The ability to view document files submitted by users facilitates the verification process and helps maintain the integrity and security of the platform. Importantly, administrators cannot modify or alter any of the KYC information, ensuring data integrity and compliance with privacy regulations.
viewPermissions
Grants access to the Permissions sub-menu within the Security page, enabling administrators to review user permissions, roles, and access levels without the ability to modify or alter them. Administrators can review:
Permission Name: The name or title of the permission.
Used by (Amount of Roles): The number of roles utilizing this permission.
For each permission, administrators can examine:Roles: The roles assigned to the permission.
Actions: The actions permitted by the permission.
Components: The components or areas of the system affected by the permission.
By providing access to this information, administrators can effectively manage user permissions, ensure appropriate access levels for different roles, and maintain the security and integrity of the system. Additionally, administrators are restricted from making any modifications or alterations to the permissions, ensuring the consistency and reliability of the access control system.
viewManualRateSources
Grants access to the manual rate source sub-menu within the Configuration page, allowing administrators to review settings related to manual rate sources for the market without the ability to modify or alter them. The main details include:
Market: Specifies the market for which the manual rate source is configured.
Base currency: Indicates the base currency of the market.
Quote currency: Represents the quote currency of the market.
Rate: Denotes the exchange rate set manually for the specified market.
CreatedAt: Indicates the timestamp when the manual rate source was created.
UpdatedAt: Indicates the timestamp when the manual rate source was last updated.
Administrators can utilize this information to ensure that accurate exchange rates are applied to the specified markets. However, administrators are restricted from making any modifications or alterations to these settings, ensuring the integrity and accuracy of the manual rate sources within the system.
viewRoles
Grants access to the Roles sub-menu within the Security page, enabling administrators to review user roles and permissions without the ability to modify or alter them. Administrators can review:
Role Name: The name or title of the role.
Amount of Permissions for Role: The number of permissions assigned to the role.
List of All Permissions for Role: A comprehensive list of all permissions associated with the role.
By providing access to this information, administrators can effectively manage user roles and permissions, ensure appropriate access levels for different roles, and maintain the security and integrity of the system. Additionally, administrators are restricted from making any modifications or alterations to the roles and permissions, ensuring the consistency and reliability of the access control system.
viewOperations
Permission: Grants access to view the operations page, allowing administrators to monitor and review operational activities and processes within the system without the ability to modify or alter them. Administrators can review:
a. Operations Sub-menu: Allows administrators to review various types of operations, including:
Custodial deposits and withdrawals
Internal withdrawals and deposits
Regular deposits and withdrawals
Donations
Exchanges
Emissions
Locked transfers
Advanced moves
Non-custodial exchanges
Deposit and trade rewards
Swaps
For each operation, administrators can view main details such as type, status, input and output amounts, associated parent operations, user details, creation and last update timestamps, transaction documents, descriptions, and ledger records.
b. Orders Sub-menu: Enables administrators to review order details, including:
Order Status
Market
Order type
Order side
Date timestamps
Order Amount
Executed volume
Price
Average executed price
User details
Operation details
Number of trades for the order
Trade details
c. Trades Sub-menu: Provides main details for each trade, including:
Date
Market
Trade amount
Price
Volume
Maker and taker fees
Maker order side
Seller and buyer details
Associated sell and buy orders
d. Pending Withdrawal Sub-menu: Allows administrators to review details of pending withdrawal operations, providing a list of pending withdrawal operation details.
This permission grants administrators access to the operations page, where they can monitor and review various operational activities and processes within the system. Administrators can access sub-menus for operations, orders, trades, and pending withdrawals, allowing them to gain insights into different aspects of the system's operation without the ability to modify or alter any data. This access facilitates effective monitoring and management of operational activities, ensuring the smooth functioning of the system.
viewPaymentInterfaces
This permission grants access to the Payment Interfaces sub-menu within the Configurations page, enabling administrators to review settings related to payment methods, gateways, or interfaces without the ability to modify or alter them. Administrators can review:
ID: The unique identifier for the payment interface.
Title: The title or name associated with the payment interface.
Subtitle: Additional descriptive text or information about the payment interface.
Logo: The logo or visual representation of the payment interface.
Description: Detailed information or specifications about the payment interface.
MultiCurrency Status: Indicates whether the payment interface supports multiple currencies.
Invoice-Based Status: Indicates whether the payment interface supports invoice-based transactions.
Collectable Status: Indicates whether the payment interface allows for collections or incoming payments.
Blockchain Status: Indicates whether the payment interface is blockchain-enabled.
Created At (Timestamp): The timestamp indicates when the payment interface was created.
Connected Currencies: Lists the currencies connected to the payment interface.
This permission allows administrators to comprehensively review payment interface settings and configurations, facilitating efficient management of payment methods within the system.
viewCurrencyPI
The permission enables the review of settings and main information for connected currency payment interfaces. This encompasses details such as:Currency Type: Denotes the specific type of currency associated with the payment interface, whether it's a cryptocurrency or a fiat currency.
Subunits: Indicates the smaller units or subdivisions of the currency, such as cents for dollars or satoshis for Bitcoin.
Contract Address: Refers to the unique address on the blockchain associated with the currency, particularly relevant for cryptocurrencies like Ethereum.
Blockchain Fee Information: Provides details about the fees associated with blockchain transactions, including any fees required for processing transactions on the blockchain network.
Minimum Collection Amount: Specifies the minimum amount required for collections or incoming payments to be processed through the payment interface.
User Withdrawal Details: Includes information on user-initiated withdrawals, specifying both the minimum and maximum withdrawal amounts allowed.
User Direct Deposit Details: Encompasses details related to direct deposits made by users, including the minimum direct deposit amount, direct deposit fee as a percentage, and the minimum and maximum direct deposit fees.
Proxy Deposit Details: Refers to details concerning proxy deposits, which are temporary deposits created for specific purposes. This includes the minimum deposit amount, the deposit fee as a percentage, and the minimum and maximum deposit fees associated with proxy deposits.
This permission facilitates the comprehensive review of currency payment interface settings and information, ensuring efficient management of financial transactions within the system.
Edit Permission
With edit permission, administrators can modify and update existing data or settings within the system. This includes making changes to user information and adjusting configurations to better align with the organization's needs. Additionally, in scenarios involving workflow settings, admins with edit permission can directly initiate changes.
Furthermore, if required, workflows can be structured to allow employees with edit permissions to request approval for proposed alterations from another administrator through task creation, ensuring proper oversight and governance over system modifications. This permission enables admins to actively manage and customize the system according to evolving requirements and preferences.
editEmployee
Grants the ability to modify and update information related to an employee, such as their roles, permissions, or employment status in the Employees sub-menu on the Security page. It also allows the creation of a new employee by adding the user's email and selecting the role(s) for the employee.editWithdrawalRestriction
This permission grants the ability to modify existing withdrawal restriction levels or create new ones on the Restrictions page. This includes adjusting withdrawal limits, eligibility criteria, or any other parameters governing withdrawal transactions.
Main details to edit for existing levels:
Level Name: The name or label associated with each restriction level, providing clarity on the purpose or criteria of the level.
Limit (in Key Platform Currency): Specifies the withdrawal limit for each level, typically expressed in the platform's native currency.
Icon: An optional visual representation or icon associated with each restriction level, aiding in quick identification.
Main details to create a new level:
Level Number: The numerical identifier for the new restriction level.
Name: The name or label associated with the new restriction level, providing clarity on the purpose or criteria of the level.
Amount: Specifies the withdrawal limit for the new level, typically expressed in the platform's native currency.
editUserKYC
This permission grants the ability to modify the KYC (Know Your Customer) status of a user in the Users Directory sub-menu on the Users page. This includes updating the verification status or marking the user as verified or unverified for Email, Phone, and Profile verification steps.
editManualRate
Grants the ability to modify the manual rate source for a specific market or create a new manual rate source for an existing market in the ManualRateSource sub-menu on the Configurations page. This includes updating the exchange rates manually or adding new rate sources for the specified market.setSoftBan
This permission grants the ability to impose a soft ban on either a specific user or on all users. This involves restricting access or certain functionalities for the designated user(s), usually as a temporary measure, without permanently suspending their account(s).Administrators with this permission can perform the following actions:
Soft ban or soft unban a specific user in the User Directory sub-menu on the Users page.
Soft ban or soft unban all existing users in the Softban sub-menu on the Security page.
This capability allows administrators to enforce temporary restrictions when necessary, maintaining control over user access and functionalities within the system without resorting to permanent account suspensions.
reset2FA
Grants the ability to turn off or disable the enabled two-factor authentication (2FA) for a specific user in the Users Directory sub-menu on the Users page. This action removes the requirement for the user to provide additional authentication beyond their password when logging into their account or to confirm withdrawal operation.editStaking
This permission grants administrators the ability to edit Staking configurations in the Currencies sub-menu on the Staking page. It allows them to update currencies and their staking-enabled status in the list of all available currencies. In the currency details, administrators can configure staking settings, including:
Staking Enabled Status: Indicates whether staking is enabled for the currency.
Staking APR (Annual Percentage Rate): Specifies the annual percentage rate of return for staking the currency.
Min Staking Amount: Specifies the minimum amount required for staking.
Instant Unstaking Enabled Status: Indicates whether instant unstaking is enabled for the currency.
Staking Period: Specifies the duration for which the currency needs to be staked to earn rewards.
Permission provides administrators with comprehensive access to manage configurations for staking-related currencies, ensuring efficient management of staking activities and rewards within the system.
editMarket
This permission grants access to the Markets sub-menu within the Configurations page, enabling administrators to edit existing market-related settings or create a new market. The settings include:General Market Configuration:
ID: Unique identifier for the market.
Base Currency: Currency used as the base in trading pairs.
Quote Currency: Currency used as the quote in trading pairs.
Min Base Currency Amount: Minimum amount allowed for base currency transactions.
Min Quote Currency Amount: Minimum amount allowed for quote currency transactions.
Commission Currency: Currency used for trading commissions.
Swap Quote->Base Price Precision: Precision level for swapping quote currency to base currency.
Swap Base->Quote Price Precision: Precision level for swapping base currency to quote currency.
Trading Settings:
Enabled Status: Indicates if trading is enabled for the market.
Trading Bot Status: Indicates if a trading bot is active for the market.
Market Position: Position of the market.
Amount Precision: Precision level for amount values in trading.
Minimum Amount: Minimum amount allowed for trading.
Price Precision: Precision level for price values in trading.
Minimum Price: Minimum price allowed for trading.
Maximum Price: Maximum price allowed for trading.
Maker Fee (%): Percentage maker fee applied to transactions.
Taker Fee (%): Percentage taker fee applied to transactions.
Swap Types Statuses:
On-Chain Swap Enabled: Indicates if on-chain swapping is enabled.
Off-Chain Swap Enabled: Indicates if off-chain swapping is enabled.
Chain-In Swap Enabled: Indicates if chain-in swapping is enabled.
Chain-Out Swap Enabled: Indicates if chain-out swapping is enabled.
Swap Commission Details:
Quote->Base (%): Percentage commission for quote currency to base currency swaps.
Quote->Base (Minimum): Minimum commission for quote currency to base currency swaps.
Quote->Base (Maximum): Maximum commission for quote currency to base currency swaps.
Base->Quote (%): Percentage commission for base currency to quote currency swaps.
Base->Quote (Minimum): Minimum commission for base currency to quote currency swaps.
Base->Quote (Maximum): Maximum commission for base currency to quote currency swaps.
Additionally, this permission allows administrators to add a new trading bot for the market or update existing bots with main configurations:
Bot user email
Bot user password
Quantity of orders per side
Create order timeout (in seconds)
Minimum amount
Maximum amount
Spread (%)
Bot enabled status
Moreover, administrators can update the enabled status for existing rate sources for the market.
Additionally, administrators have the permission to change enabled toggle statuses in the Markets sub-menu on the Configurations page for On-Chain Swap status, Off-Chain Swap status, DisableTrading Bot, and Enabled status.
editCurrency
This permission grants access to the Currencies sub-menu within the Configurations page, enabling administrators to update settings related to currencies or create a new currency. Key settings include:
Name: The name or identifier of the currency, such as USD, BTC, ETH, etc.
User Balance Enabled Status: Specifies whether the user balance feature is enabled for the currency. When enabled, users can hold balances in this currency within the system.
Precision: The number of decimal places used to represent fractional amounts of the currency.
Position: Determines the position of the currency symbol relative to the numerical value (e.g., before or after the number).
Icon URL: The URL link to the icon or image representing the currency, often used for visual identification purposes.
Timestamps (Created At/Updated): Indicates the timestamps for when the currency configuration was created and last updated.
Light Theme Colors: The color scheme used for displaying the currency details in a light-themed interface.
Dark Theme Colors: The color scheme used for displaying the currency details in a dark-themed interface.
Enabled Status: Indicates whether the currency is currently enabled and available for use within the system.
Hidden Status: Specifies whether the currency is hidden or not displayed to users within the system interface.
Trading Commission Enabled Status: Indicates whether trading commissions are enabled for transactions involving this currency.
Payout Platform Commission: Specifies the commission or fee charged by the platform for payouts or withdrawals made in this currency.
This permission allows administrators to access and update configurations or create new currencies, providing them with the necessary tools to manage and customize currency-related functionalities according to the platform's requirements and user needs.
Additionally, administrators have the permission to change enabled toggle statuses in the Currencies sub-menu on the Configurations page for User balance enabled status, Enabled status, Hidden status, and Trading commission-enabled status for all existing currencies.
editRole
This permission grants the ability to modify existing roles or create new ones within the system in the Roles sub-menu on the Security page. It includes defining role permissions, access levels, and privileges for different user groups, and ensuring appropriate access and security measures are in place.
Administrators with this permission have the possibility to add or remove permissions for already existing roles. Additionally, they have the option to create a new role, where they can define the role name and add existing permissions to it. This flexibility allows administrators to tailor roles and permissions according to the specific needs and requirements of their organization, ensuring proper access control and security protocols are maintained across the system.editWorkflow
This permission grants the ability to modify existing workflows or create entirely new workflow configurations within the system in the Workflows sub-menu on the Configurations page. It encompasses defining workflow steps, approval processes, task assignments, and automation rules to streamline business operations and improve efficiency.Administrators with this permission can create a new workflow, specifying details such as the workflow name, initial component, parameters, and enabling its status.
Additionally, administrators can add or update nodes within the workflow, configuring various conditions, parameters, and creating specific steps flow. This includes options such as:
Flexible user decision
Calling any action of any service
Checking permissions
Checking roles
Copying data
Deleting values
Implementing conditions
Setting values
Starting nodes
Ending nodes
This comprehensive set of capabilities empowers administrators to design and implement workflows tailored to their organization's needs, facilitating smoother operations and improved efficiency across the system.
editBlockchain
This permission grants the ability to modify existing blockchain configurations within the system in the Blockchains sub-menu on the Configurations page. This includes adjusting parameters such as network settings, consensus mechanisms, or block validation rules to accommodate changes in blockchain technology or network requirements. Additionally, it allows the creation of a new system wallet if it has not been generated yet, connecting additional blockchain services, and resetting differences for block reading (height parameter)editUserStatus
Grants the ability to modify the status of a user account, either banning or unbanning the user in the User Directory sub-menu on the Users page. This action restricts or restores the user's ability to access the system and perform activities based on their account status.editUserWithdrawalRestriction
This permission grants the ability to adjust the withdrawal restriction level for a verified user in the User Directory sub-menu on the Users page, either increasing or decreasing it. This action modifies the withdrawal limits, eligibility criteria, or processing times for the user's withdrawal transactions based on their verified status. However, there is no option to decrease the restriction level to zero (unverified) if the user has at least level one. Additionally, there is no option to increase the level from zero if the user has an unverified profile. Once the user's profile is verified, the level automatically tops up from zero to level one.editCurrencyPI
This permission enables the update of settings and main information for connected currency payment interfaces, as well as the ability to connect new Currency Payment Interfaces or delete existing ones in the Currencies(details) sub-menu on the Configurations page. This encompasses options such as:
Currency Type: Denotes the specific type of currency associated with the payment interface, whether it's a cryptocurrency or a fiat currency.
Subunits: Indicates the smaller units or subdivisions of the currency, such as cents for dollars or satoshis for Bitcoin.
Contract Address: Refers to the unique address on the blockchain associated with the currency, particularly relevant for cryptocurrencies like Ethereum.
Minimum Collection Amount: Specifies the minimum amount required for collections or incoming payments to be processed through the payment interface.
User Withdrawal Details: Includes information on user-initiated withdrawals, specifying both the minimum and maximum withdrawal amounts allowed.
User Direct Deposit Details: Encompasses details related to direct deposits made by users, including the minimum direct deposit amount, direct deposit fee as a percentage, and the minimum and maximum direct deposit fees.
Proxy Deposit Details: Refers to details concerning proxy deposits, which are temporary deposits created for specific purposes. This includes the minimum deposit amount, the deposit fee as a percentage, and the minimum and maximum deposit fees associated with proxy deposits.
This permission facilitates the comprehensive review of currency payment interface settings and information, ensuring efficient management of financial transactions within the system.
Additionally, there is an additional permission that allows administrators to upload/update the logo for the Payment Interface in the Payment Interfaces subsection on the Configurations page.
Request Operation Permission
These permissions grant administrators the ability to perform operational tasks within the system. This may include managing user balance through deposit and withdrawal operations, managing operations, and performing other administrative duties necessary for the smooth operation of the system.
resolveOperationError
This permission allows administrators to manage operations encountering errors. Administrators can opt to retry collection for deposit operations, retry or reject withdrawal operations, and retry exchange operations to ensure smooth processing and resolve any arising issues. Upon the request to update an operation, a task is created where an employee with approval permissions can review the main details of the request, such as Type, Status, Amount, User, Date, Documents (transactions), Description, and the employee who made the request. Then approver can make an accept or reject decision for the request.
useWorkspace & manageTasks
The "useWorkspace" and "manageTasks" permissions allow employees to access the Workspace page. This page is relevant for both Requester and Approver employees. Requesters can view the list of open tasks and their status, while Approvers can review the main task details and make an 'accept' or 'reject' decision.cancelOrder
This permission allows administrators to cancel open orders placed by users within the system. It enables administrators to intervene in trading activities and manage order books effectively, ensuring the integrity and stability of the trading platform.
Upon the request to cancel an open order, a task is created where an employee with approval permissions can review the main details of the request, such as the user's email and the main details for the open order: Status, Market, Type, Side, Date, Amount, Executed Volume, Price, Average Executed Price, Trades and the employee who made the request. Then approver can make an accept or reject decision for the request.requestWithdrawal
This permission allows the admin to request the transfer of funds from the user's wallet balance to an internal account of the system. After the withdrawal request is made, a task is created where an employee with approval permissions can review the main details of the request, such as the user's status, balance, requested withdrawal amount, currency ID, currency payment interface ID, and the employee who made the request. Then approver can make an accept or reject decision for the request.requestDeposit
This permission enables the admin to request deposit operations, initiating the transfer of funds from an internal system account to the user's wallet balance.
Upon the deposit request, a task is created where an employee with approval permissions can review the main details of the request, such as the user's status, balance, requested deposit amount, currency ID, currency payment interface ID, and the employee who made the request. Then approver can make an accept or reject decision for the request.
Approval Permission
The approval permission grants an employee the authority to approve or reject requests, transactions, or configurations from other employees. It enables administrators to review and take action on pending requests, ensuring compliance with established procedures and maintaining operational integrity. This permission allows the user to review task descriptions, general information, and requested updates or new creations in the open tasks. The approver can make decisions with an accept or reject flow by analyzing the task description. If the decision is to accept, the new configurations, changes, or edits will be implemented. Conversely, if the decision is to be rejected, no changes will be made.
acceptWithdraw
The permission allows administrators to approve withdrawal requests submitted by other requester-employees through task creation by the requester. This initiates the transfer of funds from the user's account to the specified destination. Approvers can review information in the task about the user's status, balance, requested withdrawal amount, currency ID, currency payment interface ID, and the employee who made the request.acceptCurrency
The permission allows administrators to approve updates to existing currencies or create new ones. Other requester employees submit these requests through task creation. Approvers can review information in the task, including the current settings for the currency, the requested configurations, and the employee who made the request.The main details that can be updated for existing currency or for creating a new one include:
Currency ID
Name
User Balance Enabled Status
Precision
Position
Icon URL
Light Theme Colors
Dark Theme Colors
Enabled Status
Hidden Status
Trading Commission Enabled Status
Payout Platform Commission
acceptSoftBan
The permission enables administrators to approve updates for user Softban status, either for a specific user or for all existing users. Other requester employees submit these requests through task creation. Approvers can review information in the task, including the current status for the user's Softban or the status for Bulk Softban for all users, the requested status for the user's Softban or Bulk Softban for all users, and the employee who made the request.acceptMarket
The permission allows administrators to approve updates to existing markets or create new ones. Other requester employees submit these requests through task creation. Approvers can review information in the task, including the current settings for the market, the requested configurations, and the employee who made the request.The main details that can be updated for an existing market or for creating a new one include:
Market ID
Base Currency
Quote Currency
Min Base Currency Amount
Min Quote Currency Amount
Commission Currency
Swap Quote->Base Price Precision
Swap Base->Quote Price Precision
Trading Settings:
Enabled Status
Trading Bot Status
Market Position
Amount Precision
Minimum Amount
Price Precision
Minimum Price
Maximum Price
Maker Fee (%)
Taker Fee (%)
Swap Types Statuses:
On-Chain Swap Enabled
Off-Chain Swap Enabled
Chain-In Swap Enabled
Chain-Out Swap Enabled
Swap Commission Details:
Quote->Base (%)
Quote->Base (Minimum)
Quote->Base (Maximum)
Base->Quote (%)
Base->Quote (Minimum)
Base->Quote (Maximum)
Additionally, this permission allows administrators to review tasks related to a new trading bot for the market or update existing bots with main configurations:
Bot user email
Bot user password
Quantity of orders per side
Create order timeout (in seconds)
Minimum amount
Maximum amount
Spread (%)
Bot enabled status
Furthermore, administrators can observe and decide on tasks related to updating the enabled status for existing rate sources for the market.
Additionally, administrators have permission to review tasks and either accept or reject requests based on enabled toggle statuses in the Markets sub-menu on the Configurations page for On-Chain Swap status, Off-Chain Swap status, Disable Trading Bot and Enabled status.
acceptReset2FA
The permission enables administrators to approve the disabling of 2FA verification for users. Other employee requesters submit these requests through task creation. Approvers can review information in the task, including the current status of the user's 2FA verification, the requested status changes, and the employee who made the request. This permission allows approvers to review and make decisions on requests to reset the two-factor authentication (2FA) verification for a user, ensuring that such requests are properly reviewed and authorized before the user's 2FA settings are reset.acceptDeposit
The permission enables administrators to approve deposit requests submitted by other employees through task creation. This initiates the deposit of funds to the user's account from an internal system account. Approvers can review information in the task about the user's status, balance, requested deposit amount, currency ID, currency payment interface ID, and the employee who made the request. It ensures that such requests are properly vetted and authorized before funds are transferred.acceptReferralsGroup
The permission enables administrators to approve updates to existing referral groups or create new ones. Other requester employees submit these requests through task creation. Approvers can review information in the task, including the current settings for the referral group, the requested configurations, and the employee who made the request.acceptStaking
The permission allows administrators to approve updates for staking configurations of existing currencies. Other requester employees submit these requests through task creation. Approvers can review information in the task, including the current settings for the staking currency, the requested configurations, and the employee who made the request.acceptUserVerification
The permission allows administrators to approve updates for user verification statuses, such as email verification, phone verification, and profile verification. Other requester employees submit these requests through task creation. Approvers can review information in the task, including the current statuses for user verification, the requested statuses for verification, and the employee who made the request.acceptManualRate
The permission allows administrators to approve updates to existing rates for Manual Rate Source or create new ones. Other requester employees submit these requests through task creation. Approvers can review information in the task, including the current settings for the rate for the existing market, the requested market rate changes, and the employee who made the request.acceptUserWithdrawalLevel
The permission enables administrators to approve updates for user withdrawal restriction levels. Changes can only be made for verified users, with options to increase or decrease the level. Other requester employees submit these requests through task creation. Approvers can review information in the task, including the current withdrawal restriction level, the requested withdrawal restriction level, and the employee who made the request.acceptUserStatus
The permission enables administrators to approve updates for user statuses, such as banning or unbanning. Other requester employees submit these requests through task creation. Approvers can review information in the task, including the current statuses of the user, the requested user statuses, and the employee who made the request.acceptCurrencyPI
The permission enables administrators to approve updates to existing Currency Payment Interfaces, delete existing ones, or create new ones. Other requester employees submit these requests through task creation. Approvers can review information in the task, including the current settings for the Currency Payment Interfaces, the requested configurations, and the employee who made the request.The main details that can be updated for existing currency or for creating a new one include:
Currency Type
Subunits
Contract Address
Minimum Collection Amount
User Withdrawal Details
User Direct Deposit Details
Proxy Deposit Details
Additionally, there is an additional permission that allows administrators to review tasks and make decisions related to uploading or updating the logo for the Payment Interface in the Payment Interfaces subsection on the Configurations page.
acceptRole
The permission grants administrators the authority to approve updates to existing Roles or create new ones. Other requester employees submit these requests through task creation. Approvers can review information in the task, including the current settings for the Role and its permissions, the requested configurations, and the employee who made the request.
acceptRateSource
The permission allows administrators to modify the status of existing Rate Sources for a market. Other employees submit requests for these changes through task creation. Approvers can review information in the task, including the current status of the Rate Source for the market, the requested status change, and the employee who initiated the request.acceptEmployee
The permission enables administrators to approve updates to existing Employees or create new ones. Other employees submit requests for these actions through task creation. Approvers can review information in the task, including the current settings for the Employee and their roles, the requested roles for the Employee, and the employee who initiated the request.acceptWithdrawalRestrictionLevel
The permission allows administrators to approve updates to existing Withdrawal Restriction Levels or create new ones. Other requester employees submit these requests through task creation. Approvers can review information in the task, including the current settings for the Withdrawal Restriction Levels, the requested configurations, and the employee who made the request.
acceptBlockchain
The permission enables administrators to modify the status of existing Blockchains on the platform. Other employees submit requests for these changes through task creation. Approvers can review information in the task, including the current status of the Blockchain, the requested changes (such as enabling or disabling), resetting the 'height' parameter, and the employee who initiated the request.acceptOperation
The permission allows administrators to modify the status of failed operations on the platform, such as failed collection for deposit operations, failed withdrawal operations, failed off-chain operations, failed on-chain swap operations, and canceling open orders. Other employees submit requests for these changes through task creation. Approvers can review information in the task, including the current status of the operation, the requested changes (such as retrying or rejecting failed operations, closing open orders), and the employee who initiated the request.
Troubleshooting
Common Issues and Solutions
Error Messages and Their Meanings
Glossary
Definitions of Key Terms Used in the Documentation
Appendix
Additional Resources
Contact Information for Support