Broker Guide

Getting started

Authorization

Log in to the system with your credentials.

If you have trouble logging in, check that your login/password pair, language, and Caps Lock key are correct. If everything seems to be correct but you still cannot log in, contact the system administrator.

Interface layout and options

After you log in, you will be redirected to the homepage. The homepage is divided into three main sections: top bar, side bar and a main panel.

Top bar

This section displays several useful information components:

  • Server time — displays the current server time. All events occurring in the system, such as registrations, transactions, payments, etc., are given a server time and date.

  • message buttonmessage icon — available to users with admin rights. Displays the number of unread messages or events to which the particular admin was tagged. Click this icon to view a list of unread messages with a brief description of each message. To see more details about a specific message, click the selected message.

  • antifraud buttonsecurity icon — displays the number of new security events logged by the system, such as anti-fraud notifications. Click this icon to view a list of security events and a brief description of each event. To see more details about a specific security event, click the selected event.

  • system notificationsbell icon — displays a number of unread system notifications, such as client requests, etc. Click this icon to view a list of unread system notifications and a brief description of each notification. To view more details about a particular system notification, click the selected notification.

  • language buttonlanguage button — displays the current user interface language. Click this button to select another language from the available options.

  • username buttonuser button — all user profiles in the system are managed by the administrator, therefore this button only functions as a logout button.

Side bar

This section is located on the left side of the page and allows you to navigate between the different sections of the system. Most of the partnership program functionality tools are grouped in an Introducing Brokers section. To hide the side bar click the sandwich button.

Main panel

The main panel displays all the important information for the selected menu section. The data is displayed in either tabular or tabbed form.

General Features

The common functionality features of the main panel are the following:

  • sandwich buttonsandwich button — click to hide or show the sidebar. Useful, when working with large tables.

  • create buttoncreate button — click to create a new element.

  • export buttonexport button — click to export data from the current table or tab. Export function is available to users with Export permissions.

  • search buttonsearch button — click to apply search filters you have entered.

  • reset buttonreset button — click to clear applied search filers .

  • edit buttonedit button — click to edit an element. If your profile does not have enough Edit permissions (set by an administrator), clicking this button will only allow you to view details of the selected entry or a tab.

  • delete buttondelete button — click to delete an element.

Table view settings

  • column visibilitycolumn visibility — click to view a list of all available fields for this particular table. Mark and unmark fields to show or hide them in your table.

  • rows selectorrows selector — select a number of entries to be displayed on each page.

  • page selectorpage selector — click right or left arrows to move between the pages of the table, or click on a page number to open it.

Filtering

  • Start Date/End Date — enter the start and end dates to view the filtered data for the specified time period.

  • To filter the data in a table, type in a value in a selected field or choose the filter option from the drop down list. Unselect or clear the entered values to set the table back to its original state.

Sorting

  • inactive arrowsup and down arrows — indicate that the data in the table is not sorted by the values of this field. To sort the table data by the values of this field, click on the arrows:

    • up arrowup arrow — indicates that the data in the table is now sorted by the values of this field in ascending order.

    • down arrowdown arrow — indicates that the data in the table is now sorted by the values of this field in descending order.

Key terms

Below are listed terms and basic concepts of IB.

IB program (IB Type)

A set of criteria based on which you will pay rewards and a set of parameters for calculating these rewards. You can have one or more IB types. You can range rewards inside each type.

Partner

A client who signed up to the B2Core UI and joined your IB program. Let’s say, it is Jack.

Direct client

A client who signed up to the B2Core UI by the referral link of your partner. Let’s say, it is Jill. For trades of Jill, you pay Jack the Level 1 ratio.

SubIB

A client who registered to the B2Core UI by the referral link of your partner and joined your IB program. Let’s say, it is Jill. Clients brought by Jill are not direct clients of Jack, but we can still trace them back: JackJillClients brought by Jill. Jill has many friends, so 100 of them registered to the B2Core UI and started trading via the SubIB.

Levels

You pay Jill the Level 1 ratio for the trades of brought clients. For example, the Level 1 multiplier is 1. You may want to pay Jack the Level 2 ratio for the same trades (because if not for Jack, Jill might not have joined the program and would not have brought so many clients). For example, the Level 2 multiplier is 0.5. And so on. The depth of the tree of clients is not limited, and you choose the number of paid levels. With the Max amount payment plan, you can also limit the total reward amount and specify reward amounts for each level as a fixed value, not a ratio.

Tiers

You can encourage your partners with extra motivation. For example, you can configure increased tier ratio for each partner who bring 100 active clients for 30 days. You are interested in trades, so you can configure increased tier ratio for trading volume. Or both at once.

Personal ratio

Individual configuration of reward amount. For example, you can pay increased rewarding to partners who bring you many clients and trades.

Master IBs

If you have special partners (these could be, for example, partners who bring many new clients, or partners you have been working with for a long time) you can assign such partners with MasterIB status. For such partners, you can configure individual number of levels for which you pay rewads and fix ratio for these levels. MasterIB settings overwrite settings of your IB program for this partner. You can configure Master IB status in your partner profile.

Key Performance Indicators

IB provides reporting and KPI on attracting clients, trading activity, and finance of your partners.

You can view total number of any entity in the Introducing brokers section directly under the name of a subsection.

Reward configuration

You pay your partners a certain percentage of the profit which you receive from trades of their clients. Available revenue sharing options are listed below. Each option can be configured for opening, closing, or opening and closing of positions. Each option can be applied to a single symbol or to a group of symbols. Ref. to How to configure IB rewards for step-by-step description of reward configuring.

Commission (applicable for MT4/5, B2Trader)

You pay partners a percentage of commissions received for trades of their clients.

Reward amount = Commission × Percentage.

For example, if you set percentage = 10% and clients of Jack brought you 70 USD commissions, then the reward amount for Jack is calculated as: 70 USD × 0.1 = 7 USD.

Lot (applicable for MT4/5)

You pay partners a fixed amount for each lot traded by their clients.

Reward amount = Traded Volume (in lots) × Amount per Lot.

For example, if you set the amount per lot = 2 USD for ETHEUR asset and clients of Jill traded 10 lots (1 lot = 0,1 ETH), then the reward amount for Jill is calculated as: 10 lots × 2 USD = 20 USD. Note that the reward currency doesn’t depend on the asset traded.

Max amount (applicable for MT4/5)

You pay partners a fixed amount for each lot traded by their clients, but with the opportunity to set the maximum reward amount and to specify the reward amount for each configured level.

With the Lot payment plan, you set the reward amount per lot for Level 1. Rewards for next levels (if configured) are calculated as a percentage of Level 1 reward. With the Max amount payment plan, you set total amount of the reward which you pay to partners regardless of the number of levels, and then specify the exact amount which a partner receives at each level. The table below shows an example of how the reward amount can be distributed depending on the number of levels.

1 level

2 levels

3 levels

4 levels

5 levels

6 levels

Level 1

10 USD

8 USD

5 USD

5 USD

4 USD

3 USD

Level 2

2 USD

3 USD

3 USD

2 USD

2 USD

Level 3

2 USD

1 USD

2 USD

2 USD

Level 4

1 USD

1 USD

1 USD

Level 5

1 USD

1 USD

Level 6

1 USD

For example, direct clients of Jack traded 10 lots. There is only one level, so the reward amount for Jack is calculated as: 10 lots × 10 USD = 100 USD.

If direct clients of Jill (who is Jack’s SubIB) traded 10 lots, then there are two levels. In this case, the reward amount for Jill (Level 1) is calculated as: 10 lots × 8 USD = 80 USD, and the reward amount for Jack (Level 2) is calculated as: 10 lots × 2 USD = 20 USD. Total = 100 USD, 10 USD per traded lot.

Markup (applicable for MT4/5)

You pay your partners a reward related to traded volume by their clients and markup set in points.

Reward amount = Traded Volume (in lots) × Markup (in points).

For example, your markup on the platform is 14 points. You decide to give your partner 1/7 of your markup, that is, 2 points. Clients of Jack traded 10 lots on Forex/AUDCAD, then the reward amount for Jack is calculated as: 10 lots × 2 points = 20 CAD.

If the currency of Jack’s wallet differs from the quote currency, then the reward amount is converted to the wallet currency (for example, USD or BTC) when credited.

Markup %

You pay partners a percentage of markup per trades of their clients. Calculations depend on the trade side:

Reward amount for buy: Traded Volume × Trade Price × 2 × Markup Value % / (1 – Markup Value %)

Reward amount for sell: Traded Volume × Trade Price × 2 × Markup Value % / (1 + Markup Value %)

For example, if you set markup % = 0.0001 and a client of Jill bought 10 lots for 6.996 USD on Forex/EURUSD, then the reward amount for Jill is calculated as: 10 × 6.996 USD × 2 × 0.0001 / (1 – 0.0001) = 13.99 USD.

Program

Introducing brokers

This page displays a full list of partners that joined your IB program. The information is presented in a table form, with table fields indicating the following:

ID

Identifier of the partner.

Name

Partner’s name.

Country

Country which was specified during registration or KYC.

Email

Partner’s email.

Client ID

Client identifier of the partner in the B2Core UI.

Direct clients

Number of direct clients of the partner.

Trading volume, lots

Total trading volume for which the rewards were paid. Trading volume of all clients of all levels are summarized. Quick filtering by non-zero/zero trading volume (Yes/No) is available.

Trading volume, USD

Total trading volume for which the rewards were paid. Trading volume of all clients of all levels are summarized. Quick filtering by non-zero/zero trading volume (Yes/No) is available.

Reward amount

Total amount of paid rewards.

IB Type

IB program to which the partner joined.

Master

Indicates whether a partner has a Master status or not.

Levels

Number of levels, set up in IB Types.

Registration date

Date and time of joining the IB program.

Details

To see detailed information about your partner, click partner’s name or the pencil icon on the right side of the table.

Personal data tab

Partner’s profile. Here you can configure personal payment preferences, block the partner, change partner’s program.

Banners tab

Banners statistics for this partner. Fields and details are described in Banners.

Links tab

Links statistics for this partner. Fields and details are described in Links. You can also set up the QR codes generator on this tab. For detailed information about QR code generation ref. to How to set up the QR code generator.

Clicks tab

Clicks statistics for this partner. Fields and details are described in Analytics. Clicks statistics can be exported by users with Export permissions via the Export button. All entries in an exported data set are sorted in the same way they were in the original table.

Clients tab

A list of clients and SubIBs brought by this partner. Fields and details are described in Clients. This list can be exported by users with Export permissions via the Export button. All entries in an exported data set are sorted in the same way they were in the original table.

Rewards tab

A list of all rewards paid to this partner. Fields and details are described in Rewards.

Reports tab

Reports on paid rewards. You can group trades by time interval (Group by hour/day/week/month/year) and filter by period. To filter trades, set the desired time period in the Period start and Period end fields. To learn more, refer to Payment report.

Clients

On this page you can view a table with the list of all clients and SubIBs brought by your partners.

Registration date

Date of a client’s registration.

Name

Client’s name.

Country

Client’s residence.

Email

Client’s email address.

Client ID

Identifier of the client in the B2Core UI.

Open trading volume, lots

Volume of client’s open positions, in lots.

Closed trading volume, lots

Volume of client’s closed positions, in lots.

IB Type

IB program of the partner who brought this client.

Details

To see detailed information about a client, click client’s name or the pencil icon on the right side of the table.

Personal data tab

Client’s profile. Contains Acquisition — referral chain of partners.

Accounts tab

A list of client’s trading accounts. Fields and details are described in Accounts.

Deposits tab

A list of deposit operations of the client. Contains date and time, account number, amount, currency and unique number of the operation on the trading platform.

Withdrawals tab

A list of withdrawal operations of the client. Contains date and time, account number, amount, currency and unique number of the operation on the trading platform.

Trades tab

A list of client’s trades. Fields and details are described in Trades.

Types

On this page you can see a list of IB types. Each type defines joining options and reward calculations for an IB program. You can create an unlimited number of types.

ID

IB program identifier in the system.

Name

Name of the IB program.

Levels

Levels of the IB program.

  • Level — level of the partner.

  • Ratio — configuration of the reward amount.

  • Created — a date on which the Level was created.

  • Updated — a date on which the Level was updated.

Tiers

Tiers of the IB program .

  • Name — a Tier name.

  • Active traders — number of active traders required for this Tier.

  • Trading volume, lots — trading volume in lots required for this Tier.

  • Ratio — reward configuration for this Tier.

  • Created — a date on which the Tier was created.

  • Updated — a date on which the Tier was updated.

Payments

Period of reward payments.

Registration

Type of joining partners to the IB program:

  • Auto — IB account is automatically created for each client signing up to the B2Core UI. If you have more than one IB types, for each client accounts in all types will be created.

  • Public — your clients can see available IB programs in the B2Core UI and can apply for it.

  • Private — you can add partners to IB program only via the Back Office. Applying via the B2Core UI is unavailable.

  • Restricted — clients can join this program only via the link from other partner of other IB type.

Introducing brokers

Total number of partners who joined the IB program.

Direct clients

Total number of direct clients (Level 1) of your partners.

Reward amount

Amount of rewards which you have already paid to your partners, with currency of payments.

Created

Date and time of the IB program created.

Details

Preferences tab

On this tab you can see general setting of the IB program.

ID

IB program identifier in the system. This value cannot be edited.

Name

Name of the IB program. You can set the localization for this field by clicking the localization button next to the field. Note that only enabled localizations are displayed. You can enable or disable localizations in the System > Localizations section.

Description

Additional information about the IB program. You can also set the localization for this field. Note that only enabled localizations are displayed. You can enable or disable localizations in the System > Localizations section.

Registration

Type of joining partners to the IB program:

  • Auto — IB account is automatically created for each client signing up to the B2Core UI. If you have more than one IB types, for each client accounts in all types will be created.

  • Public — your clients can see available IB programs in the B2Core UI and can apply for it.

  • Private — you can add partners to IB program only via the Back Office. Applying via the B2Core UI is unavailable.

  • Restricted — clients can join this program only via the link from other partner of other IB type.

Masked email

If Enabled, email and name of the partner is not displayed to clients.

Payments

Period of reward payments.

Show all levels

If Yes, all configured levels are displayed; default value is No.

Tier period

The number of days in which amounts set on the Tiers tab must be achieved by a partner to receive increased rewarding.

Currency

Currency in which partners will receive rewards. This value depends on the selected product and cannot be edited.

Product

Link to product with partner type. This value cannot be edited.

Created

Date and time of the IB program creation. This value cannot be edited.

Symbols tab

On this tab you can see a list of all available symbols on the platforms connected to the IB program. Platforms can be connected/disconnected in the Platforms. You can also export or import a symbol table by clicking the corresponding buttons in the top right corner of the window.

Symbol

Symbol code.

Name

Symbol name.

Platform

Platform name.

Trading group

Symbol group as it is defined on the platform.

Payment plan

Payment preferences for the symbol, that is the configuration of rewards calculation. Can be set as percentage of commission, set amount per lot, markup, or markup percentage. You can configure rewards depending on opening/closing of positions. Refer to Reward configuration for details.

Position

Positions for which you pay rewards: Open, Closed or Open&Closed.

Levels tab

On this tab you can set payment levels. They define how many levels of partners you want to reward and which multiplier will be used for reward calculation.Level 1 is created by default. You can create unlimited number of levels depending on your IB program design. Additionally, you can export Level Settings of an IB Program by clicking Export button. This feature is only available to users that have Export permissions. All entries in an exported data set are sorted in the same way they were in the original table.

Level

Sequence number of the level.

Ratio

Rewards multiplier.

Tiers tab

On this tab you can configure tiers. Tier is a special reward multiplier for clients who achieved set amount(s) of traded volume/brought clients in tier period. You can create Tiers table by clicking the Create button. Additionally, you can export Tiers Settings of an IB Program by clicking the Export button. This feature is only available to users that have Export permissions. All entries in an exported data set are sorted in the same way they were in the original table.

Name

Tier name.

Active traders

Required number of brought active clients to receive increased rewarding. Set value to 0 to ignore this parameter in reward calculations.

Trading volume, lots

Required amount of traded volume to receive increased rewarding. Set value to 0 to ignore this parameter in reward calculations.

Ratio

Reward multiplier.

Rewards tab

On this tab you can see all rewards paid to your partners. You can export this table to CSV file by clicking the Export button.

Reward ID

Identifier of the reward payment which is a link to detailed info. In the detailed info you can see parameters which were active at the moment of the reward calculation.

Trade ID

Identifier of the trade for which the reward was paid.

IB Name

Name of the partner.

IB Email

Email of the partner.

Level

Level of the partner.

Master

If Yes, the partner is a Master IB.

Currency

Currency of crediting.

Amount

Reward amount in the currency of crediting.

State

Current status of the reward payment:

  • Done — the reward was successfully credited to the partner’s account

  • Pending — the reward was calculated, but not yet credited to the partner’s account

  • Cancelled — the reward was cancelled and debited from the partner’s account

Transaction ID

Identifier of the transaction crediting the reward to the partner’s account. Note that multiple rewards can be paid in one transaction depending on the configured payment period. To see the number of rewards, click the transaction ID.

Trade execution time

Date and time of the trade.

Created

Date and time of reward crediting.

Reports tab

Reports on paid rewards. You can group trades by time interval (Group by hour/day/week/month/year) and filter by period. To filter trades, set the desired time period in the Period start and Period end fields. To learn more, refer to Payment report.

Promo

Analytics

Clicks

On this page you can view a table with all clicks and related information.

ID

Identifier of the click.

Landing page

Page, to which a click on a link lead.

Registration

Name of the client who registered in the B2Core UI.

Country of Residence

Country which was specified by the client during registration.

Contact Email

Email of the client who registered in the B2Core UI.

Client ID

Link to the client’s profile in the B2Core UI.

IP Address

IP address from which registration was made.

Latitude, Longitude

Geographical coordinates.

Country

Country from which registration was made based on IP.

User-Agent

User-Agent HTTP Header.

Referrer

Request source URL.

URL

Resource identifier.

UTM Campaign, UTM Content, UTM Medium, UTM Source, UTM Term

Campaign parameters of the URL, ref. to Google Analytics Help Center for details.

Created

Date and time of the click.

Details

Detailed information additionally contains Affiliate Token.

Banners

In this subsection you can create and delete promo banners.

Banners

On this page you can view all available promo banners with specified parameters and analytics.

Banner

Banner image.

Name

Banner name.

Language

Banner language.

Size

Banner size.

Theme

Rubric to which the banner is related to.

Clicks

Total number of clicks on the banner.

Registrations

Number of clients who clicked on the banner and registered.

Click Conversion Rate

Click conversion rate.

Created

Date of a banner creation.

Preferences

The Preferences tab allows you to view, set, and change the details of the banner. To access it, click the banner name or the pencil icon on the right side of the page. The Preferences tab contains the following fields:

Name

Banner name.

Language

Banner language.

Size

Banner size.

Theme

Rubric to which the banner is related to.

CDN Image URL

Link to image URL and image preview.

Clicks

Total number of clicks on the banner.

Registrations

Total number of registrations resulted by the banner.

Click Conversion Rate

Conversion Rate of all banner clicks.

Created

Banner creation date .

Updated

Date and time of the last banner update.

Themes

Themes are used to conveniently group banners into categories. On this page you can view all created themes and banners related to them. To view theme Preferences, click the theme’s name.

You can also create a theme on this page by clicking Create.

Languages

On this page you can view a list of banner languages and the amount of banners related to them. To view language Preferences, click the language.

Sizes

On this page you can create and configure banners sizes and banners related to them. To view size Preferences, click the size. Preferences contains additionaly Width and Height fields.

Landings

QR Codes

In this subsection you can view the information on QR codes, edit the existing QR codes or create new ones.

Colors

On this page you can view the information about QR codes colors.

Priority

Color priority.

Name

Color name.

Background color

Color hex code of the background.

Foreground color

Color hex code of the Foreground.

Created

Date and time of color creation.

Details

By clicking the color name you can you can navigate to the detailed information about the color. On this page you can edit values of the fields mentioned on the Colors page. Also you can view date and time of the last updates in the Updated field.

Icons

On this page you can view the information about QR codes icons.

Priority

Color priority.

Icon

Icon image.

Name

Icon name.

Created

Date and time of icon creation.

Details

By clicking the icon name you can you can navigate to the detailed information about the icon. On this page you can edit values of the fields mentioned on the Icons page. Also you can view date and time of the last updates in the Updated field.

Platforms

In this subsection you can view the information on trading platforms, groups, accounts, symbols and trades.

Accounts

On this page you can view a list of trading accounts of clients registered via the IB program.

Platform

Name of the trading platform.

Group

Trading group name as it is set on the trading platform. List of trading groups can be exported by users with Export permissions via the Export button. All entries in an exported data set are sorted in the same way they were in the original table.

Type

Account type, one of:

  • Default

  • Payment account

  • PAMM investment account

  • PAMM master account

Account

Account number on the trading platform.

Currency

Currency in which this account is nominated.

Trades

Total number of trades on this account.

Deposits

Amount of deposits.

Withdrawals

Amount of withdrawals.

Balance

Current balance.

Credit

Credit amount.

Equity

Account’s equity.

Commission

Total amount of paid commissions.

Swap

Total amount of swaps.

Profit

Profit before commissions.

PnL

Profit/loss.

Name

Name of the client in IB.

Email

Email of the client in IB.

Client ID

Identifier of the client IB profile.

Archived

If Yes, this account was archived on the trading platform.

Enabled

Disabled accounts are excluded from data synchronization and reward payment. All accounts are enabled (Yes) by default. You can change this status in the account details.

Created

Date and time of account creation on the trading platform.

Details

Account tab

Contains general information about an account.

Deposits tab

A list of deposit operations on the account. Contains date and time, account number, amount, currency and unique number of the operation on the trading platform.

Withdrawals tab

A list of withdrawal operations on the account. Contains date and time, account number, amount, currency and unique number of the operation on the trading platform.

Trades tab

A list of all trades of this account:

Trade execution time

Date and time of the trade.

Platform

Trading platform name.

Trade ID

Trade Identifier.

Side

Buy or Sell.

Symbol

Symbol code.

Volume

Trading volume.

Position

Position state (Closed or Open).

Rewards

Number of paid rewards for this trade.

Groups

On this page you can view details and configured payment preferences for all groups of symbols on the trading platforms.

Platform

Name of the trading platform.

Group

Group of trading accounts as it is set on the trading platform.

Trades

Number of trades made by IB clients.

Created

Date and time of group creation on the trading platform.

Details

Platform

Name of the trading platform.

Group

Group of trading accounts as it is set on the trading platform.

Currency

Currency of accounts opened in this group.

Lot Size

Defaults to standard lot (1.00); 0.01 for cent groups.

Archived

If Yes, this group was archived on the trading platform.

Created

Date and time of group creation on the trading platform.

Symbols

On this page you can view details of all symbols on the trading platforms.

Platform

Name of the trading platform.

Trading group

Symbol group name as it is set on the trading platform. Note that the field is not displayed for wildcard symbols.

Symbol

Symbol code. Note that the field is not displayed for wildcard symbols.

Trades

Total trades number.

Created

Date and time of symbol creation on the trading platform.

Details

If you pay rewards for trades on this symbol, IB type and payment plans will be given below the general info.

Symbol tab

Detailed information about the symbol:

Trading platform

Name of the trading platform.

Symbol

Symbol code.

Base Currency

First currency listed in a currency pair.

Quote Currency

Second currency listed in a currency pair.

Archived

If Yes, this symbol was archived on the trading platform.

Created

Date and time of symbol creation.

Payment plan tab

Detailed information about the payment plan:

#

Sequence number.

Type

IB program type.

Payment plan

Configuration of rewards calculation.

Position

Open or Closed.

Created

Date and time of the payment plan creation.

Create button

By clicking this button you can create a new symbol by selecting IB Type, Payment Plan and Currency. Also you need to fill out the Amount field and select Position.

Edit button

By clicking this button you can edit symbol values. The fields on the edit form are identical to those of the creation form, except you cannot select IB Type while editing.

Trades

On this page you can view a table with the list of all trades of all IB clients and key information on each trade.

Trade execution time

Date and time of the trade.

Platform

Name of the trading platform.

Account type

Account type, one of:

  • Default

  • Payment account

  • PAMM investment account

  • PAMM master account

Account

Trading account number.

Trade ID

Identifier of the trade on the trading platform.

Side

Trade side: Buy or Sell.

Symbol

Trade symbol.

Volume

Trading volume in lots.

Position

Open or Closed.

Rewards

Number of paid rewards for this trade.

Details

To access trades data, click on a pencil icon or on values in the Trade execution time, Trade ID fields.

Trade data tab

Detailed information about the trade:

Trading platform

Name of the trading platform.

Trading account

Account number of the client who performed this trade.

Trade ID

Identifier of the trade on the trading platform.

Trade execution time

Date and time of the trade.

Side

Buy or Sell.

Symbol

Symbol name.

Base Currency

First currency listed in a currency pair.

Quote Currency

Second currency listed in a currency pair.

Price

Trade execution price.

Volume

Trading volume.

Commission

Amount of commissions paid for the trade.

Client Email

Email of the client.

Client ID

Identifier of the client.

Rewards tab

Detailed information about rewards if in the Trades table Rewards value is set to Yes.

Reward ID

Reward identifier.

Introducing broker

Name of the IB client.

Type

IB program type.

Level

Client level.

Currency

Reward currency.

Amount

Reward amount.

State

Current status of the reward payment. Possible values of the field:

  • Done — the reward was successfully credited to the partner’s account

  • Pending — the reward was calculated, but not yet credited to the partner’s account

  • Cancelled — the reward was cancelled and debited from the partner’s account

Created

Date and time of reward calculation.

Deposits

On this page you can view a list of deposits of all clients on all trading accounts. By default, the list is sorted by date in descending order (newer deposits appear at the top of the list).

For a list of deposits specified by a client, navigate to Program > Clients > Details > Deposits tab.

For a list of deposits specified by a trading account, navigate to Plafroms > Accounts > Details > Deposits tab.

Date

The date and time of a deposit creation.

Platform

The name of a trading platform.

Account

The number of a trading account.

Currency

The currency of a deposit.

Amount

The amount of a deposit.

ID

The identifier of a deposit.

Details

To see deposit details, click the deposit ID or the pencil button. Detailed information contains the following fields:

Trading platform

The name of a trading platform.

Platform unique value

The unique number of the operation on the trading platform.

Trading account

The number of a trading account.

Base currency code

The currency of a deposit.

Amount

The amount of a deposit.

Withdrawals

On this page you can view a list of withdrawals of all clients on all trading accounts. By default, the list is sorted by date in descending order (newer withdrawals appear at the top of the list).

For a list of deposits specified by a client, navigate to Program > Clients > Details > Withdrawals tab.

For a list of deposits specified by a trading account, navigate to Plafroms > Accounts > Details > Withdrawals tab.

Date

The date and time of a withdrawal creation.

Platform

The name of a trading platform.

Account

The number of a trading account.

Currency

The currency of a withdrawal.

Amount

The amount of a withdrawal.

ID

The identifier of a withdrawal.

Details

To see withdrawal details, click the withdrawal ID or the pencil button. Detailed information contains the following fields:

Trading platform

The name of a trading platform.

Platform unique value

The unique number of the operation on the trading platform.

Trading account

The number of a trading account.

Base currency code

The currency of a withdrawal.

Amount

The amount of a withdrawal.

Platforms

On this page you can view a table with the information on all trading platforms connected to IB.

ID

Platform identifier in IB.

Name

Name of the trading platform.

Status

Enabled or Disabled.

Trades

Number of trades on this platform.

Created

Date and time of platform connection to IB.

Details

Preferences tab

Trading platform settings. Contain a link to platform details in the Back Office, provider, credentials, and date and time of the platform editing. Click the Platform ID link — you will be redirected to the Edit platform page. Do not forget to click Save after editing the platform information.

Drivers tab

By default, Report and Wrapper are configured. Drivers have a Priority property, this means that if a driver with priority 1 fails, the backup driver with priority 2 is used and so on. In case if all drivers fail, the service reports that the function cannot be performed. When creating a driver, it is automatically assigned the lowest priority; the priority can be changed when a driver is being edited.

You can run diagnostics by clicking the Test connection button. To edit a driver data, click the driver name — you will be redirected to the driver details page. Do not forget to click Save after editing the driver details.

Payments

This subsection contains information about reward payments to your partners.

Accounts

On this page you can view IB accounts of all your clients.

Account

Account number, link to the detailed info.

Client ID

Identifier of the partner in the B2Core UI.

Contact Email

Email of the partner in the B2Core UI.

IB Name

Name of the partner in the B2Core UI.

IB Type

Type of IB program.

Created

Date and time of the account creation.

Details

To see or edit account details, click the account number or the pencil button. Detailed information contains the following tabs:

Account tab

Account details, same as displayed in the accounts list.

Transactions tab

A list of all reward transactions on this account. Refer to Transactions for fields and explanations.

Currencies

On this page you can view a list of supported currencies. Fiat currencies comply with ISO 4217.

Name

Currency name.

Alias

Different currency designation on trading platforms.

Alphabetic code

As per ISO 4217 for Fiat currencies, conventional for crypto.

Numeric code

As per ISO 4217 for Fiat currencies, conventional for crypto.

Minor unit

Currency precision, the number of digits after a decimal separator.

Sign

Currency symbol.

Class

Fiat, Crypto, Other Securities and Metals.

Created

Date and time of currency creation.

Details

To see or edit currency details, click the currency name. Detailed information duplicates the information in the table.

Methods

Payment methods are necessary for your partners to receive rewards to their wallets. You can create a new method by clicking the Create button.

Name

A name of the method. By default, the Wallet method is configured.

Created

Date and time of method creation.

Details

To see or edit method details, click the method name or the pencil button. Detailed information contains the following tabs:

Preferences tab

Method provider, name and date of method creation are displayed. You can edit the Name field.

Drivers tab

You can run diagnostics by clicking the Test connection button.

Rates

On this page you can view a list of all connected rate providers. By default, at least one provider is configured. You can create a new provider by clicking the Create button.

If you use custom crypto, you can create your own static rate.

Priority

If you have more than one provider configured, data from them will be requested in the order specified in the priority. That is, if the required rate is not received from the provider with priority 1, this rate will be searched for from the provider with priority 2, and so on.

Name

Provider name.

Created

Date and time of rate provider creation.

Details

To see or edit rate provider details, click the provider name or the pencil button. Detailed information contains the following tabs:

Preferences tab

Rate provider, priority, name and date of rate creation are displayed. You can edit the Name and Priority fields.

Drivers tab

You can run diagnostics by clicking the Test connection button.

Rewards

On this page you can view a list of all paid rewards.

Trade execution time

Date and time of the trade.

Trade ID

Identifier of the trade for which this reward was paid.

ID

Identifier of the reward payment which is a link to detailed info. In the detailed info you can see parameters which were active at the moment of the reward calculation.

Trade account type

Account type, one of:

  • Default

  • Payment account

  • PAMM investment account

  • PAMM master account

Currency

Reward currency.

Amount

Reward amount.

Level

Level of the client.

IB Name

Name of the partner.

IB Email

Email of the partner.

IB Type

Type of IB program.

Transaction ID

Identifier of the transaction crediting the reward to the partner’s account. Note that multiple rewards can be paid in one transaction. To see the number of rewards, click the transaction ID.

State

Current status of the reward payment:

  • Done — the reward was successfully credited to the partner’s account

  • Pending — the reward was calculated, but not yet credited to the partner’s account

  • Cancelled — the reward was cancelled and debited from the partner’s account

Created

Date and time of reward calculation.

Details

To see reward details, click the trade execution time or the pencil button. Detailed information contains the following tabs:

Reward state

Current status of the reward payment:

  • Done — the reward was successfully credited to the partner’s account

  • Pending — the reward was calculated, but not yet credited to the partner’s account

  • Cancelled — the reward was cancelled and debited from the partner’s account

Reward amount

Total amount of the reward.

Exchange rate

Account type, one of:

  • Default

  • Payment account

  • PAMM investment account

  • PAMM master account

Transaction amount

Amount of the transaction.

Transaction ID

Transaction identifier.

Level

Partner’s level.

Introducing broker

IB name.

Payment plan

Configuration of rewards calculation.

Level ratio

Configuration of reward amount for the partner’s level.

Personal ratio

Individual configuration of reward amount.

Tier ratio

Configuration of reward amount for the tier.

Tier name

Name of the tier.

Tier period

Number of days in which amounts set on the Tiers tab must be achieved by a partner to receive increased rewarding.

Created

Date of the reward payment.

Trading platform

Name of the trading platform.

Trade account type

Account type, one of:

  • Default

  • Payment account

  • PAMM investment account

  • PAMM master account

Trading account

Account number of the client who performed this trade.

Trade ID

Trade identifier.

Trade execution time

Date and time of the trade.

Side

Buy or Sell.

Symbol

Symbol code.

Base currency

Base currency of the trade.

Quote currency

Quote currency of the trade.

Contract size

Trade amount.

Price

Execution price.

Volume, lots

Trade volume, in lots.

Volume, USD

Trade volume, in USD.

Commission

Amount of commission paid.

Client email

Email of the client who performed the trade.

Client ID

Client identifier in the B2Core UI.

Transactions

On this page you can view a list of all reward transactions.

ID

Identifier of the transaction.

Currency

Currency in which rewards were paid.

Amount

Transaction amount.

Account number

Number of partner’s account.

Client ID

Identifier of the partner in the B2Core UI.

IB Name

Partner’s name.

IB Email

Partner’s email.

IB Type

Type of IB program.

Created

Date and time of the transaction.

Details

Transaction tab

Same as displayed in the transactions list.

Rewards tab

A list of rewards that have been credited to the partner’s account by this transaction. Refer to Rewards for fields and explanations.

Reports

In this subsection you can generate and export reports on paid rewards and active partners.

Acquisition report

The following parameters for filtering are available:

  • Group by — way to group the filtered data. You can group data by country/region, by referrer, by partner or by time (from an hour to a year).

  • IB Type — type of IB.

  • Start date — beginning of the reporting period.

  • End date — end of the reporting period.

After selecting parameters, the report is generated automatically. Above the report table, you can see totals by reporting period and the trend compared to the previous period:

Active partners

Number of joined partners whose clients have at least one trade during the reporting period.

Clicks

Number of clicks.

Registrations

Number of registrations.

Click Conversion Rate

Calculated according to the formula: Registrations / Clicks × 100 %

In the report table, you can see the same indicators grouped by selected parameter.

You can export the report table with selected parameters (without totals) by clicking the Export button in the upper right corner of the window.

Payment report

The following parameters for filtering are available:

  • Group by — way to group the filtered data. You can group data by partner or by time (from an hour to a year).

  • IB Type — type of IB.

  • Start date — beginning of the reporting period.

  • End date — end of the reporting period.

After selecting parameters, the report is generated automatically Above the report table, you can see totals by reporting period and the trend compared to the previous period:

Active partners

Number of joined partners whose clients have at least one trade during the reporting period.

Active traders

Number of traders who have at least one trade with paid rewarding during the reporting period.

Trades

Number of trades for which the partners received rewarding during the reporting period.

Trading volume, lots

Volume of trades for which the partners received rewarding during the reporting period, in lots.

Trading volume, USD

Volume of trades for which the partners received rewarding during the reporting period, in USD.

Rewards

Amount of paid rewards (in the CREDITED status) for the reporting period, in USD.

In the report table, you can see the same indicators grouped by selected parameter.

You can export the report table with selected parameters (without totals) by clicking the Export button in the upper right corner of the window.

Preferences

This subsection of the IB does not require your regular attention and mainly contains system settings and configurations. Nevertheless, it can be useful for you to manage security on the application level, monitor the operating or to run some processes manually.

Apps

On this page you can view a list of all applications which have access to the IB via API and time of application registration.

App Name

Name of the application.

Registration Date

Date and time of the application registration.

Details

You can navigate to the detailed information about an application by clicking its name.

App Name

Name of the application.

Client ID

Public identifier of your application.

Client Secret

Private identifier of your application. It allows to verify the identity in the authentication step of our API.

Note

Your Client ID and Client Secret identify you and are essential for protecting yourself and your customers. Make sure you keep them in a safe place.

Registration date

Date and time of the application registration in the system.

For more information on how to create a new application ref. to How to access the API.

Date & time

This page contains current date/time and time zone of the IB server. Date and time values in the IB section are displayed in accordance with these settings.

Please note that you cannot edit fields in this subsection.

Location

Countries

On this page you can view a list of countries used for geodata. The parameters and the list of countries are in accordance with ISO 3166. You can add/edit countries if the current list does not meet the needs of your IB programs.

Geolocation

On this page you can view a list of connected geo services. By default, you are provided with the service which determines the geolocation of the client by the IP address. You can edit existing geolocations or add new ones.

Details

To view the detailed information about the geolocation service, click the link in the Name field.

Preference tab

On this tab you can see the detailed information about your geolocation provider, such as the provider’s Name, Priority and date and time of the service creation. You can edit the Name and Priority fields.

Database tab

On this tab you can see the detailed information about the database:

Version

Database version. Database updates are set up automatically, but on this page you can also check for the latest updates and set them up manually by clicking the Update button.

Records

Number of database records.

Size

Database size.

Updated

Date and time of the last database update.

Drivers tab

On this tab you can see the information about drivers:

ID

Driver identifier.

Name

Driver name. This is a link to the detailed information about the driver.

Diagnostics

You can run diagnostics by clicking the Test connection button.

Created

Indicates, when the driver was created.

Network

On this page the IB connection is set up.

In the API Status field you can see the current status of API connection and quickly find out the problem. The most frequent cases are listed below:

  • Running — IB is functioning correctly

  • Maintenance — IB is being updated

  • NotFoundHttpException — wrong API Base URL

  • SSL Certificate Problem — certificate has expired

Security

IP addresses

On this page you can view a list of IP addresses to which the access to the IB is allowed or prohibited.

IP Address

IPv4 or IPv6 address.

Policy

Type of the rule: allow or deny.

Time to live

Optional: time in seconds during which this rule is in effect.

Expires

Date and time when the rule expires.

Created

Date and time of the rule creation.

Authorizations

Authorization is a process of obtaining access token by credentials. On this page you can view a list of all successfully authorized API users with specified IP addresses, Client ID, User-Agents, date and time of token obtaining and updating, as well as date and time of token expiring.

Authentifications

On this page you can view a list of all API users who accessed the IB with access tokens and their IP addresses, User-Agents, and time of authentications.

Incidents

Incident is a failed attempt to obtain a token because of invalid credentials. If the number of incidents exceeds the Auth attempts value set on the Blacklist page, then this is considered an attack. On this page you can view all the incidents with specified IP addresses, User-Agents, unique fingerprints (device parameters) and Attack statuses.

Attacks

Attack is an excess of the permissible number of auth incidents specified in the Auth attempts field on the Blacklist page. On this page you can see a list of all attacks registered in the system, indicating the number of incidents, IP address, and attack time.

Blacklist

Blacklist provides settings for protection from brute-force attacks. IP address from which you receive multiple failed authorization attempts is automatically blacklisted for a set amount of time. You can set the IP addresses in the Blacklist yourself.

Enabled

Current protection status.

Auth attempts

Number of unsuccessful authorization/authentication attempts after which the Blacklist is triggered.

Deny, seconds

Amount of time (in seconds) for which the IP address will be blocked.

Whitelist

If Enabled, Whitelist restricts access to IP addresses listed on the Addresses page in the Security section and prohibits access to all other IPs.

Updates

This page contains current versions of the B2Core IB and a link to Release Notes.

Processes

On this page you can monitor all system processes which are running on the server or manually via the Back Office by clicking the Run process button.

Date

Date and time of process start.

Process name

Process name:

  • Clear Cache (cache) — clearing cache for the specified time period

  • Sync Accounts (accounts) — synchronization of trading accounts with trading platforms

  • Sync Groups (groups) — synchronization of trading groups with trading platforms

  • Sync Symbols (symbols) — synchronization of symbols with trading platforms

  • Sync Trades (trades) — synchronization of trades with trading platforms

  • Create Payments (payments) — creating of reward payments

  • Process Payments (transactions) — rewards transferring

  • Cancel Payments (cancel) — reverting the reward payments. For details refer to How to cancel payments

  • Run Diagnostics (diagnostics) — IB service diagnostics

Logs

Number of entries in the log for process with debugging. The filter by severity level is available, severity levels comply with RFC 5424 Standard.

Memory

The amount of memory used by the process.

CPU Time

The amount of time which the process took.

PID

Identifier of the process in the system.

Exit code

Result of the process:

  • 0 — the process completed successfully

  • 1 — the process was not completed due to errors

  • 2 — the process was gracefully stopped due to service maintenance

Logs

On this page you can view IB server logs of the system:

Date

Date and time of the logged event.

Level

Level of severity, comply with RFC 5424 Standard.

Message

Log message which is a link to detailed log info for reporting. You can view the whole message text and details of the message by clicking the link.

PID

Identifier of the process in the system.

Version

B2Core IB version.