How to add, edit or delete deposit or withdrawal methods
Last updated
Last updated
To add a deposit or withdrawal method:
For deposit methods, navigate to System > Deposit system > Deposit methods. For withdrawal methods, navigate to System > Payout system > Payout methods.
Click +Create in the upper-right page corner.
In the popup, 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.
In the Provider dropdown, select a provider that you want to use for deposit or withdrawal transactions.
In the Currency dropdown, 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 confirmation popup.
Navigate either to System > Deposit system > Deposit methods or to System > Payout system > Payout methods.
Click +Create in the upper-right page corner.
In the popup, fill in the following fields:
In the Name field, enter Manual.
In the Caption field, enter either Manual Deposit or Manual Withdrawal.
In the Provider dropdown, select manual.
In the Currency dropdown, 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 make deposits, and the manual withdrawal method to make payouts. For details, refer to How to create a deposit and How to create a payout.
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 then click the Edit button located in the method row.
On the Edit deposit method or Edit payout method page, go to the Commissions tab and click +Add.
In the Create commission popup, fill in the following fields:
In the Currency dropdown, select a commission currency.
In the Type dropdown, select TR for transaction currencies or PSP for payment system currencies.
Enter commission rates in the respective fields shown in the image displayed below.
The use of these fields follows the formula:
Minimum commission amount (1) <= Fixed rate (2) + Percentage rate % (3) <= Maximum commission amount (4)
You can set a fixed commission rate, a percentage commission rate, or a combination of both.
To set a fixed commission rate, enter the commission amount in the field 2. The specified commission amount is charged for each deposit or withdrawal transaction regardless of the transaction amount.
For fixed commission rates, leave the other fields empty.
To set a percentage commission rate, enter the percentage value in the field 3. The specified percentage of a deposit or withdrawal amount is charged as a commission.
For percentage commission rates, it’s recommended that you set the minimum commission amount in the field 1 and the maximum commission amount in the field 4. The commission can’t be be lower than the minimum amount or exceed the maximum amount.
If both a fixed rate in the field 2 and a percentage rate in the field 3 are entered, the commission is calculated as the sum of the fixed amount and the specified percentage of a deposit or withdrawal amount.
For combined commissions, it’s also recommended that you set the minimum and maximum commission amounts.
Click Save to apply the commission settings.
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).
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 then click the Edit button located in the method row.
Click Actions in the upper-right page corner, and select Verification level restrictions in the dropdown.
In the Restrictions popup, fill in the following information:
In the Enabled dropdown, select Yes.
In the Type dropdown, 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.
In the Rules dropdown, select one or several verification levels.
Click Save to apply the changes.
You can add and set up custom fields for deposit and withdrawal methods that use the Constructor provider.
To add a custom field:
Navigate to System > Deposit system > Deposit methods or to 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 popup, fill in the following fields:
In the Caption field, enter a field name. The name will be displayed in the B2CORE UI.
In the Type dropdown, select a field type. The following types are available:
Text — to add a text field.
Select with autocomplete — to add a field with predefined options. When a client begins typing in this field, options that match the entered characters are displayed, enabling the client to select the desired one.
File — to add a field for attaching a document necessary for depositing or withdrawing funds.
Click Save to add the custom field.
To configure properties of the newly added field, click the Edit button located in the field row:
In the displayed Main field settings section, you can make the field mandatory by selecting required in the Rules field.
For a field of the Select with autocomplete type, add a list of predefined options. The options can be added manually or uploaded automatically by connecting to an appropriate API resource (for details, refer to How to upload a list of predefined options for a custom field)
For a field of the File type, in the Document type dropdown, select the type of a document that clients should attach. The list of available document types includes all the types configured on the Verification > Document types page.
Clients can attach files in JPEG, PNG, or PDF format with the file size up to 3 MB.
Currently, only one field for attaching files can be added for the Constructor method.
Click Save to apply the changes.
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.
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:
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:
In the Options from key dropdown, select the root element of the specified API resource.
In the Option value from key dropdown, select the resource field specifying the values of predefined options displayed for the custom field (such as bankId).
In the Option caption from key dropdown, 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.
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 (for details, refer to How to upload a list of predefined options for a custom field).
To dynamically form a list of predefined options for a custom field:
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:
In the Depends on field dropdown, select another custom field (such as “Country”) that you want to associate with the “Bank name” field.
In the Depends on field by key dropdown, 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.
