How-to Articles

How to Set Up Wallets

Wallet is a partner’s account, to which all partner’s rewards are credited.

Note

Before creating a partner product, navigate to Products > Platforms and make sure that Personal platform is enabled.

  1. Navigate to Products > Products.

  2. Click Create and select Personal.

  3. Fill out the form:

  • Select Platform Group: eWallet

  • Select Currency

  • Enter the product Name, it can be the same as currency for your convenience

  • Select Group

  • Select Type: Partner

  1. Click Save.

  2. On the Info tab of the product details:

  • Enter the Caption

  • Set Status to Enabled

  • Grant permissions: select required Rights or check eWallet in the Group rights

  • Set Max accounts to -1

  1. Click Save.

How to Register a Partner

  1. Navigate to Introducing brokers > Program > Introducing brokers.

  2. Click Create.

  3. Fill out the form:

  • Enter the Email of the client who is registered to Trader’s Room. If the client is not registered in the Trader’s Room yet, you can create the profile.

  • Select the IB program Type

  1. Click Save.

How to Create an IB Type

This article describes basic steps of creating a new IB type and levels. For more information about IB programs ref. to Introducing brokers.

Before creating a new type, make sure that the following necessary parameters are configured and enabled in the Back Office:

  • Navigate to Products > Products and check that at least one product with type Partner is created and enabled. You can use filter by type for quick search. If there is no product with this type, create one.

  • Navigate to Introducing brokers > Payments > Methods and check that at least one method is created (usually it is called Wallet). Go to method details and on the Drivers tab click Test connection. If you get OK, you can proceed. If connecting failed, contact your system administrator. Methods are necessary for your partners to receive rewards to their wallets.

  • Navigate to Introducing brokers > Promo > Landings > Links and make sure that at least one link is created. Go to link details and check that the Host field has a correct value.

  1. Navigate to Introducing brokers > Program > Types.

  2. Click Create.

  3. Fill out the form:

  • Enter a Name for 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

  • Enter a Description: this can be, for example, conditions for participation in B2Core IB. 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

  • Select a Registration type:

    • Auto — IB account is automatically created for each client signing up to Trader’s Room. 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 Trader’s Room interface and can apply for it. For this type of registration, Approvement option is available and enabled by default

    • Private — you can add partners to IB program only via the Back Office. Applying via the Trader’s Room interface is unavailable

    • Restricted — clients can join this program only via the link from other partner of other IB type. For this type of registration, select IB type in Restriction. For this type of registration, Approvement option is available and enabled by default; if the option is disabled, after the registration you will be immediately redirected to the IB Room

  • Select Payments period

  • Select Product — currency of partners accounts. You need at least one product with partner type. This value cannot be edited

  1. Click Save.

After IB type is created, you need to configure reward calculating, ref. to How to Configure IB Rewards.

How to Configure IB Rewards

This article describes basic steps of configuring payment period and multipliers for an IB type. If you have not yet created any IB type, ref. to How to Create an IB Type.

  1. Navigate to Introducing brokers > Program > Types.

  2. Select the IB type in the list and click the edit button.

  3. On the Preferences tab set Payments period: pay your partners once an hour/day/week/month.

How to Configure Tiers

  1. Navigate to Introducing Brokers > Program > Types.

  2. Click on a name of the program type you wish to create a Tier for.

  3. Navigate to the Tiers tab.

  4. Click Create.

  5. Fill out the form:

  • Enter the Name of the tier

  • Set tier Ratio — rewards multiplier for the partners who have reached volume/clients goals for a tier period

  • Set required amount of Trading volume in lots to receive increased rewarding. Set value to 0 to ignore this parameter in reward calculations

  • Set required number of Active traders to receive increased rewarding. Set value to 0 to ignore this parameter in reward calculations

  1. Click Save.

  2. Go back to the Preferences tab and set Tier period in days — the number of days in which amounts set on the previous step must be achieved by a partner to receive increased rewarding.

How to Configure Symbols

  1. Navigate to Introducing Brokers > Platforms > Symbols.

  2. Select the symbol or symbol group for which you want to configure payment preferences, then click the edit button. You can use filters by platform, group or name for quick search.

  3. In the Payment plan field, select option for reward calculation. For detailed description of available options, ref. to Reward configuration.

  4. Depending on the selected option, set percentage of commission, amount and currency per lot, or markup value.

  5. In the Position field, select for which positions you want to calculate reward: open, close, or both.

  6. In the Apply field, select whether to apply the specified settings to the current symbol or to a trading group.

  7. Click Save.

How to Configure Levels

Optionally you can configure additional levels. First level is created by default. To add a level:

  1. Navigate to Introducing Brokers > Program > Types.

  2. Click on a name of the program type you wish to add a Level for.

  3. Navigate to the Levels tab.

  4. Click Create.

  5. Set level Ratio.

  6. Click Save.

How to Block a Partner

You can temporarily disable a partner. Blocked partner does not receive rewards, the referral link of the partner cannot be used.

  1. Navigate to Introducing brokers > Program > Introducing brokers.

  2. Select the partner from the list and click the name of the partner. You can use filters by IB name, IB email or any other for quick search.

  3. In the Personal data tab, set Enabled to No.

  4. Click Save to block the partner.

You can unblock the partner any time: set Enabled back to Yes.

You can also delete the partner by clicking the delete button. Note that this action cannot be undone.

How to Change IB Type for a Partner

  1. Navigate to Introducing brokers > Program > Introducing brokers.

  2. Select the partner from the list and click the name of the partner. You can use filters by IB name, IB email or any other for quick search.

  3. In the Personal data tab, select a new IB Type.

  4. Click Save to apply changes.

You can also configure personal payment preferences for a partner.

How to Configure Personal IB Rewards

  1. Navigate to Introducing brokers > Program > Introducing brokers.

  2. Select the partner from the list and click the name of the partner. You can use filters by IB name, IB email or any other for quick search.

  3. In the Personal data tab, set Personal ratio — personal multiplier for the partner which will be used for rewards calculation.

  4. Click Save to apply changes.

How to Configure a Master IB

  1. Navigate to Introducing brokers > Program > Introducing brokers.

  2. Select a partner from the list and click the name. You can use filters by IB name, IB email or any other for quick search.

  3. In the Personal data tab, set Master to Yes.

  4. Set Master Levels — number of levels which you want to reward for this partner. Defaults to 100.

  5. Set Master Level Ratio — fixed multiplier for any level within Master IB max level value.

  6. Click Save to apply changes.

How to Access the API

  1. Navigate to Introducing brokers > Preferences > Apps.

  2. Click Register a New App at the upper right corner of the page.

  3. Specify an App name in the App Name field.

  4. Click Save.

After clicking Save you will be redirected to the page with the details about the newly created application where you can view App Name, Client ID and Client Secret.

Note

Do not forger to copy your Client ID and Client Secret.

How to Set Up the QR Code Generator

  1. Navigate to Program > Introducing brokers.

  2. Select a partner and click the partner’s name.

  3. Navigate to the Links tab and click the link in the Landing page column.

  4. Select the background color and icon for the QR code.

Note

There are two default background colors — black and white. You can customize colors, ref. to Customizing Colors for details.

Icon is optional, you can ignore this field, but remember that using an icon for QR codes can increase the number of scans by 2-3 times. You can customize icons, ref. to Customizing Icons for details.

  1. Click the Generate QR Code button.

  2. You can copy your QR code by clicking Copy Embed or download it to your device by clicking Download QR Code.

Customizing Colors

  1. Navigate to Introducing brokers > Promo > QR Codes > Colors.

  2. Click Create to create a new color and fill out the form:

    • Name — enter the name of the color

    • Background color — enter the hex code of the background

    • Foreground color — enter the hex code of the foreground

  3. Click Save to save a new color. A new color will be available in the drop-down list of colors when creating a QR code.

Customizing Icons

  1. Navigate to Introducing brokers > Promo > QR Codes > Icons.

  2. Click Create to create a new icon and fill out the form:

    • Name — enter the name of the icon

    • Icon — attach the icon file. Make sure your icon is a .png image and its size is from 128 x 128 to 512 x 512 and less than 100 KB

  3. Click Save to save a new icon. A new icon will be available in the drop-down list of icons when creating a QR code.

How to Cancel Payments

Brokers can cancel reward payments for specific trades or for an entire trading session. To cancel payments only for specific trades by Trade ID:

  1. Navigate to Introducing Brokers > Processes.

  2. Click Run Process button.

  3. Select Cancel Payments.

  4. Select Platform. Trade IDs are not unique and platform dependent. You can have the same Trade IDs across multiple platforms. So make sure to select the platform first.

  5. Enter Trade ID.

  6. Click Cancel.

To cancel payments for an entire trading session:

  1. Navigate to Introducing Brokers > Processes.

  2. Click Run Process button.

  3. Select Cancel Payments.

  4. Select Platform.

  5. Enter Start Date and End date of a period that requires payments cancellation.

  6. Click Cancel.