How-to articles Manage finances How to add, edit or delete deposit or withdrawal methods

How to add, edit or delete deposit or withdrawal methods

To add a deposit method, navigate to System > Deposit system > Deposit methods. To add a withdrawal method, navigate to System > Payout system > Payout methods.
Click +Create in the upper-right corner of the screen.
In the invoked window, fill in the following fields:

In the Name field, enter a name that you want to use for the method.

In the Caption field, enter a caption that will be applied to the method in the B2Core Back Office.

From the Provider drop-down list, select a provider that you want to use for deposit or withdrawal transactions.

From the Currency drop-down list, select a currency for deposit or withdrawal transactions. After creating the method, you can add multiple currencies to it on the TR Currencies tab.

Click Save to create the method. The created method is enabled by default.
To edit an existing deposit or withdrawal method, click the Edit button located in the method row and modify the settings displayed on the Settings, TR Currencies, PS Currencies and Commissions tabs.
To delete a deposit or withdrawal method, click the Delete button located in the method row, and then click Yes in the invoked confirmation dialog.

How to add a manual deposit or withdrawal method

Navigate either to System > Deposit system > Deposit methods or to System > Payout system > Payout methods.
Click +Create in the upper-right corner of the screen.
In the invoked window, fill in the following fields:

In the Name field, enter Manual.

In the Caption field, enter either Manual Deposit or Manual Withdrawal.

From the Provider drop-down list, select manual.

From the Currency drop-down list, select a currency for deposit or withdrawal transactions. After creating the method, you can add multiple currencies to it on the TR Currencies tab.

Click Save to create the manual method. The created method is enabled by default.

You can now use the manual deposit method to create deposits, and the manual withdrawal method to create payouts. For details, refer to How to create a deposit and How to create a payout.

How to configure commissions for a deposit or withdrawal method

Navigate either to System > Deposit system > Deposit methods or to System > Payout system > Payout methods.
Choose a method for which you want to configure a commission, and click the Edit button located in the method row.
On the Edit deposit method or Edit payout method screen, switch to the Commissions tab and click +Add.
In the invoked Create commission window, fill in the following fields:

From the Currency drop-down list, select a currency that will be used for commission calculations.

From the Type drop-down list, select TR.

Define commission rates by specifying the required amounts in the corresponding fields as described below:

To set the minimum commission amount, specify a value in the leftmost field.

To set the maximum commission amount, specify a value in the rightmost field.

To set a fixed commission amount, specify a value in the field that is displayed to the right of the less or equal (≤) symbol.

To set a percentage for commission calculation, specify a value in the field that displays the percentage (%) symbol.

Click Save to apply the changes.

How to restrict the use of a deposit or withdrawal method

You can restrict the use of specific deposit or withdrawal methods so that they can only be used by clients who have achieved specific verification levels (for example, due to regulator requirements).

Note

Verification levels must be already created and configured (for details, refer to Manage verification options).

Navigate either to System > Deposit system > Deposit methods or to System > Payout system > Payout methods.
Choose a method the use of which you want to restrict, and click the Edit button located in the method row.
Click Actions in the upper-right corner of the screen, and select Verification level restrictions from the menu.
In the invoked Restrictions window, fill in the following information:

From the Enabled drop-down list, select Yes.

From the Type drop-down list, select either of the two options:

Deny only — this option forbids the use of the method for selected verification levels.

Allow only — this option allows the use of the method only for selected verification levels.

From the Rules drop-down list, select one or several verification levels.

Click Save to apply the changes.

How to add custom fields for the Constructor deposit or withdrawal method

You can add and set up custom fields for deposit and withdrawal methods that use the Constructor provider.

To add a custom field, do the following:

Navigate to System > Deposit system > Deposit methods or System > Payout system > Payout methods.
From a method list, select a deposit or withdrawal method that uses the Constructor provider.
To navigate to the method details, click the Edit button.
On the Settings tab, navigate to the Custom fields section, and then click Add field.
In the Add field window, fill in the following fields:
- In the Caption field, specify a field name.
- From the Type drop-down list, select a field type. The following types are available:
- Text — with this field type, clients are allowed to enter text.
- Select with autocomplete — with this field type, predefined options are suggested, matching the characters entered by a client.
  
  The fields of this type must be populated with lists of predefined options. You can add them manually or upload them automatically by connecting to an appropriate API resource (see How to upload a list of predefined options for a custom field to learn more).
Click Save to add the custom field.

When clients deposit or withdraw funds with the Constructor method, the added custom fields are displayed to them in the same order as they are listed in the Custom fields section of the Back Office.

How to upload a list of predefined options for a custom field

For each custom field of the Select with autocomplete type, you can automatically upload predefined options that clients can select when they deposit or withdraw funds in the B2Core UI.

For example, instead of manually adding bank names as predefined options for the “Bank name” field, you can retrieve them from an appropriate resource defined for your application API.

To upload a list of predefined options for a custom field, do the following:

Navigate to the details of a deposit or withdrawal method that uses the Constructor provider.
On the Settings tab, navigate to the Custom fields section.
Select a field of the Select with autocomplete type for which you want to upload a list of predefined options (such as “Bank name”), and then click Edit.
Navigate to the Field dynamic options section, which is displayed below the Custom fields list, and specify the following fields:

In the Endpoint field, specify a URL of a specific API resource that includes field values that you want to use as predefined options for the selected custom field.

The structure of the specified API resource is displayed in the Endpoint result preview field. The following example illustrates a possible resource structure:
[
  {
    "id": 1,
    "bankId": 1,
    "bankName": "Bank name 1",
    "countryId": 1,
    "countryName": "UAE"
  },
  {
    "id": 1,
    "bankId": 2,
    "bankName": "Bank name 2",
    "countryId": 1,
    "countryName": "UAE"
  },
  {
    "id": 1,
    "bankId": 3,
    "bankName": "Bank name 3",
    "countryId": 2,
    "countryName": "Georgia"
  },
  {
    "id": 1,
    "bankId": 4,
    "bankName": "Bank name 4",
    "countryId": 2,
    "countryName": "Georgia"
  },
  {
    "id": 1,
    "bankId": 5,
    "bankName": "Bank name 5",
    "countryId": 2,
    "countryName": "Georgia"
  }
]
From the Options from key drop-down list, select the root element of the specified API resource.

From the Option value from key drop-down list, select the resource field specifying the values of predefined options displayed for the custom field (such as bankId).

From the Option caption from key drop-down list, select the resource field specifying the captions of the predefined options (such as bankName).

Click Save to apply the changes.

The list of predefined options for the “Bank name” custom field includes all the values retrieved from the bankName fields of the sample API resource.

How to dynamically form a list of predefined options for a custom field

A list of predefined options for a custom field can be formed dynamically and contain different options depending on the option that is selected from the custom field with which it is associated.

For example, a list of predefined options for the “Bank name” field can depend on the country that is selected in the “Country” field.

Note

To form dynamic lists of predefined options, both the associated custom fields must be populated with the options retrieved from the same API resource (see How to upload a list of predefined options for a custom field to learn more).

To dynamically form a list of predefined options for a custom field dynamically, do the following:

Navigate to the details of a deposit or withdrawal method that uses the Constructor provider.
On the Settings tab, navigate to the Custom fields section.
Select a field of the Select with autocomplete type for which you want to form a dynamic list of predefined options (such as “Bank name”), and then click Edit.
Navigate to the Field dynamic options section, which is displayed below the Custom fields list, and specify the following field settings:

From the Depends on field drop-down list, select another custom field (such as “Country”) that you want to associate with the “Bank name” field.

From the Depends on field by key drop-down list, select the resource field that will be used to filter the options for the “Bank name” field (such as countryId).

Click Save to apply the changes.

The list of bank names displayed for the “Bank name” field depends on the country that was previously selected by a client from the “Country” field.