Btop is a secured online payment application. It's easy to use. Its modular and simple architecture helps you optimizing your transactions fees and facilitates online payment services management.
How to use this guide
This user guide contains detailed informations related to the use of Btop application and allows you to discover its main features. This document is intended to online sellers and to developers. The following symbol is used to highlight important parts:
For information elements.
You can access the administration panel by choosing "BTop" from the list of available applications in Liferay's control panel. Each icon corresponds to a specific administration space, as detailed below:
This area is Btop's control tower. At a glance it provides a summary of miscellaneous information about the application. The space is divided into 4 areas:
"Last transaction" block
The block contains last 3 transactions settled with BTop. The visible information are seller name, transaction amount, date and time. Clicking on "+" redirects you to the "Transactions" board.
"Last plugins" block
The block contains last 3 plugins added, referenced by name and state of plugin. Clicking on the gear performs a quick access to configuration. Clicking on "+" redirects you to "Plugin" board.
"Last sellers" block
The block contains last 3 sellers added. It presents name and state of the seller. Quick access to seller configuration is done by clicking the gear. From this area it is possible to easily add a seller by clicking on "Add seller" (see "Sellers" board).
Clicking on "+" redirects you to the "Sellers" board.
This feature is under development. Coming soon on your application !
The area sums up all transactions related to any seller within the application. A summary is available for every transaction. You can find:
Transaction date and time.
Amount actually paid.
Current state (in progress, paid...)
To speed up navigation among all transactions, a search function is available.
Enter the transaction ID.
Click on "Ok" to show the result.
Transactions are filterable by:
Payment method and seller;
Seller name with state;
Plugins associated with sellers.
The area is dedicated to sellers management. To access the sellers page click on "Configuration" => "Plugins". From here, you are able to manage sellers account (add, edit, rules...) On the home page you can find:
A search box.
Seach filter (active or inactive).
List of seller accounts.
Seller name and state
State of associated plugins.
Add a seller
Adding a seller account is very simple :
Click on "Add seller"
Fill the input with an account name
Click on "Active" to turn on the account
Click on ">" to move to the next step
Drag & drop the plugins to associate with the seller.
Click on "X" to finish
Edit a seller
If you want to change something about a particular seller, in the list of sellers click the gear next to the desired account name
Choose between two actions "Edit seller" or "Link plugins to seller account"
Make your changes.
Select the step to modify.
Name of the seller.
Click on "Confirm" or "Cancel".
To configure a plugin for a particular seller account (ex : paypal plugin) select the gear next to the plugin name for that account. Enter the expected information and validate.
The rule engine can prioritize and optimize for each seller the use of payment modules for their transactions. Its user-friendly interface allows you to quickly define all the rules you wish to apply, from the simplest to the most complex.
The rules are available in the seller configuration.
Click on the "Rules" icon next to the seller name to set up rules for this account
Add a rule
A rule is set by conditions combined into a block. This allows a fine tuning of each rule. You can add rules for each plugin available for a particular seller.
Click on "Add rule".
Select a plugin from the drop down menu on the left to apply a rule
Click on "+" to add a condition.
Available conditions are:
«Has parameter» Tests if the paramater is true.
«Parameter is smaller than» Tests if the parameter is less than the entered value.
«Parameter (as a number) is equal to» Tests if the numeric value of the parameter is equal to entered value.
«Parameter contains» Tests if the parameter contains a piece of text.
«Parameter is equal to» Tests if the value is equal to the entered value.
«Parameter is larger than» Tests if the parameter is higher than the entered value.
«Parameter matches» Tests if the parameter matches the value (regular expression)
«Comma separated parameter contains» Tests if the value of the parameter is contained in the list.
Autocomplete is available to help while you create a rule.
Available parameters are :
"TransactionAmount", the amount of the transaction.
"CountryCode", The country code (FR, US...).
"TransactionCurrencyCode", The currency to choose (EUR, USD...).
"If", gives a positive result if the condition is true.
"If not", gives a positive result if the condition is not true.
It is possible to associate multiple rules in a block or sub-block. The drop-down menu on the left of a parent-block, allows to select plugin activation conditions:
"Any", needs at least one valid rule to select the plugin.
"All", all rules must be valid to select the plugin.
"Not all", one rule must be false to select the plugin.
"None", all rules must be false to select the plugin.
Once rules are created, it is possible to sort them. The list of rules is tested sequentially. When one of them is checked, the module goes to the next step.
You can define a plugin as default for all the transactions.
Access to this page is done by clicking on "Configuration" => "Plugins". You can configure the different plugins.
Here is the list of different items available on the home page:
Search filter, by state or payment method.
List of plugins
Plugin name and state.
Sellers accounts associated to a plugin.
Sellers accounts current state.
Configure a plugin
Each plugin is configurable. You can change the plugin name or the associated sellers in the editing window.
Edit the name of the plugin
Click on the gear to open the editing window.
Chose the step you want to access.
Enter your changes.
Click on "Confirm" or "Cancel"
Edit sellers associations
Click on "Associate sellers to plugin".
You can drag seller from "Available sellers" to the "Drag and drop seller" area to add an association between the plugin and a particular seller.
Click on "X" to remove a seller from the list.
Click "confirm" or "cancel".
To find a seller more easily, an instant search feature is available.
Access to this page is done by clicking on "Configuration" => "Methods". You are able to configure the payment methods deployed within the payment system. On the home page you will find:
Payment method names.
List of plugins that implement a given method.
A search box, in order to find the payment methods easily.
Edit the payment method name
The payment method name is editable. From this interface, only this field can be edited. Click on the gear to open the edit window.
Click on the field.
Enter your modification (Click on action icon)
Confirm and quit.