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.
...
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.
...
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:
...
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:
...
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.
...
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.
...
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.
...
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.
...
manageTasks ?
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.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.
...
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
...
editWithdrawalRestrictionLogo
This permission grants administrators the ability to
...
resolveOperationError
This permission allows administrators to manage operations that encounter errors. Administrators can choose to retry collection for deposit operations, retry or reject withdrawal operations, and retry exchange operations to ensure smooth processing and resolve any issues that may arise.useWorkspace ?
cancelOrder
This permission enables administrators to cancel open orders placed by users within the system. It allows administrators to intervene in trading activities and manage order books effectively, ensuring the integrity and stability of the trading platform.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.requestDeposit
This permission allows the Admin to request deposit operations, initiating the transfer of funds from an internal system account to the User`s wallet balance.
...
acceptCurrency
...
acceptMarket
...
acceptManualRate
...
acceptUserWithdrawalLevel
...
acceptSoftBan
...
acceptUserStatus
...
acceptCurrencyPI
...
acceptRole
...
acceptReset2FA
...
acceptRateSource
...
acceptEmployee
...
acceptDeposit
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
This permission grants employees the authority to review and approve requests from their peers to modify existing currency settings or payment interfaces or to create new ones. It ensures that changes to currency-related configurations are properly vetted and authorized before implementation.
...
acceptSoftBan
This permission allows employees to review and approve requests from their peers to modify the softban status for specific users or all users in the system. It ensures that changes to softban statuses are properly reviewed and authorized before being applied to user accounts.
...
acceptMarket
This permission grants employees the authority to review and approve requests from their peers to modify existing market settings or create entirely new markets. It ensures that changes to market-related configurations are properly vetted and authorized before implementation.
...
acceptReset2FA
This permission allows employees to review and approve requests from their peers to reset the two-factor authentication (2FA) verification for a user. It ensures that such requests are properly reviewed and authorized before the user's 2FA settings are reset.
...
add or edit logos for withdrawal restriction levels in the "24h Withdrawal Limits" sub-menu on the Restrictions page.
editCurrencyPILogo
This permission allows administrators to add or edit logos for Payment Interfaces(details) in the "Payment Interfaces" submenu on the Configurations page.editCurrencyLogo
This permission allows administrators to add or edit currency logos in the “Currencies” sub-menu on the Configurations page.
generateBlockchainWallet
This permission enables administrators to generate a new system wallet for connected blockchains in the "Blockchains" submenu on the Configurations page.editSwapMarket
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. 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.
Workflow Overview
Description of Workflow Process
Roles Involved in Workflow
Workflow Diagram
Creation Process
Steps for Requester
Initiating a Creation Request
Providing Necessary Information
Steps for Approver
Reviewing the Request
Approving or Rejecting the Request
Update Configurations
Steps for Requester
Initiating an Update Request
Providing Details of Configuration Changes
Steps for Approver
Reviewing the Update Request
Approving or Rejecting the Changes
Operations Approval
Steps for Requester
Requesting Approval for Operations
Providing Context and Details
Steps for Approver
Reviewing the Operation Request
Approving or Rejecting the Operation
Best Practices
Tips for Effective Request Submission
Guidelines for Approvers.
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. 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), and the employee who initiated the request.acceptReferralsGroup
This permission empowers administrators to approve updates to existing Referral groups or create new ones. Other employees submit requests for these actions by creating tasks. Approvers can review task information, including current settings for Referral groups and their levels, requested edits, and the initiating employee's details.acceptUserKYCStatus
This permission enables administrators to approve updates for user verification statuses, including profile verification. Requester employees submit these requests through task creation. Approvers can review task information, such as current verification statuses, requested statuses (Accept, Reject, Ban), and details of the employee who made 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