WooCommerce

Overview

The document describes the process of installing and configuring the Mokka module for CMS WooCommerce, which greatly simplifies the process of integrating with the Mokka service for a partner.

Installation

The module can be installed through the admin panel manually by transferring the module files to the server. Download the WooCommerce Mokka module before starting the instructions.

Login to your website admin panel.

1. Go to the menu "Plugins" -> "Add new".
   

2. In the top left corner hit the button "Upload Plugin".
   

3. In the appeared window select the file with the plugin in "zip" format and press "Install Now"
   

4. After the plugin has been uploaded, press the "Install Now" button.

   

5. After the successful installation, click the button "Activate plugin"

   

6. The plugin will appear by the path: "Woocommerce"-> "Plugins"-> "Мокка payment".

Settings

1. Go to the menu “WooComerce" -> "Mokka payment"
2. The tab "API settings" will be displayed. Here you can input the following parameters:
   • Status - the actual state of the module: enabled or disabled.
   • Test mode - the sandbox mode for testing and debugging. Must be unchecked for the production launch.
   • Store ID and Secret key - parameters issued by Mokka personnel. 
   • Base URL address - the default URL for production Mokka connection
   • Store ID (Test mode) and Secret key (Test mode) - parameters issued by Mokka personnel for the sandbox mode for testing and debugging. 
   • Base URL address (Test mode) - the URL for the test environment connection. By default - https://backend.demo.revoup.ru
   • Orders page - the link quick navigation to go to the orders page in the administrative panel. Generated automatically, not a subject to change.
     
3. Go to the tab "Store settings"
   • Minimum Order Value - to be set up respectively to your tariff
   • Maximum Order Value - to be set up respectively to your tariff
   • Maximum perсent, % - the percentage of the amount that the client can pay by Mokka (by default 100%)
   • Valid till (Hours:Minutes) - set up the same time as on the server on which the site is located
   • Generate invoice after Mokka accepted payment - the setting for generating a receipt after approval of the Mokka advance for the client
   • Show for all deliveries - the setting for displaying the Mokka payment method in the checkout
   • optional parameters:
   • Sort Order - position for the payment in the list.
   • Show for all deliveries - selecting of all shipping methods for which a payment method is available.
   • Shipping methods –  list of shipping methods for which the payment method will be available.
     
     
4. Go to the tab "Statuses" for mapping statuses values
   • Сanceled orders - order status, which sends information about the cancellation of the order to the Mokka service.
   • Finalized orders - the status of the order in which information about the finalization of the order will be sent to the Mokka service. Usually, this is a status that is affixed after the shipment or delivery of the order to the client.
   • New order - the status of the order applied to an order after checkout, for which a Mokka decision has not yet been received or the client has not completed checkout.
   • Full returned orders - the order status, which sends information about the return of the order to the Mokka service.
   • Approved orders - status applied to the order after a positive response from the payment system. The order has already been completed, but not finalized yet.
   • Declined orders - status applied to the order after a negative response from the payment system.
     
5. Go to the tab "Checkout" to configure the visual appearance of the Checkout phase. You may skip this step if you don't mind of using the default logos, embedded into the plugin package.
   
   • Widget display type - selection of the type of displayed image
   • Uploaded Image - uploading the logo from your computer that will be visible on the checkout.

   • Image URL - uploading an alternative logo from the URL as an external resource.

   • Payment method title - the title for a payment method which is displayed on the checkout page. The default value is “Mokka - you sweet advance”.

   • Payment method title color - color of the title on the checkout.

   • Inactive payment method text - the text to be shown in the pop-up if the loan amount is greater than the maximum or less than the minimum value.
     

6. Go to the tab "Widget & Popup"
   • Widget display - determines where exactly to show the widget. Values:
     • Product page
     • Category page
   • Maximum number of loan months - to be set up respectively to your tariff.
   • Minimum number of loan months - to be set up respectively to your tariff.
   • Widget display type - allows you to select the template for displaying the Mokka service widget.
   • optional parameters:
   • Widget content - this element is used to modify widget HTML. The widget supports HTML tags.
   • Popup content - this element is used to modify popup HTML. The popup supports HTML tags.
     
7. The settings on the tab "Additional" are optional. Allows to set up a connection to Airbrake logging.
   • Enable Airbrake error logging - enable errors logging via Airbrake. Default is disabled.
   • Airbrake Project ID - project ID in Airbrake. Required if Airbrake errors logging is enabled.
   • Airbrake Project Key - project key in Airbrake.  Required if Airbrake errors logging is enabled.
   • Send client related metadata to Revo Core - if this option is enabled plugin send Customer  metadata to the Revo Core subsystem.
   • Prefill fields - sends the user data (name, contacts, etc.) within the Registration and Checkout methods to fill in the registration form data.
     
8. Then go down the screen and click "Save settings"
   

Testing

Checkout

1. Collect the basket for the minimum amount.
2. Go to cart.
3. In the payment methods, select "Mokka - advance payment".
4. Click "Checkout".
5. A data entry form will open on the screen. Fill in all fields of the form. The phone number for approval on the test environment must match the mask +7 8881xxxxxx.
6. Click "Checkout" and enter the confirmation code (always 1111 on a test environment).
7. Select the payment schedule you are interested in and click the "Pay in advance" button.

Completion

1. Go to the "Orders" section in the WordPress admin panel.
2. Select a previously placed order by checking the box next to the respective order.
3. In the "Actions" menu, select the status "Change status to completed".
4. Click "Apply".

As a result, the order will be completed.

Cancellation

1. Go to the "Orders" section in the WordPress admin panel.
2. Select a previously placed order by checking the box next to the desired order.
3. In the "Actions" menu, select the "Change status to canceled" status.
4. Click "Apply".

As a result, the order will be canceled.

Refund

1. Go to the "Orders" section in the WordPress admin panel.
2. Open a previously placed order by clicking on its ID.
3. Change the status of the order to "Refunded".
4. Click "Update"
   

As a result, the order will be refunded.

Activation

After successfully installing the module and debugging on test data, activate the module so that the Mokka team can test the functionality and activate the service. To activate, follow the instructions:

1. Pick the status "Enabled"
2. Unselect the check box "Test mode"
3. Press the "Save settings" button.

As a result, the payment method "Mokka - advance payment" will become available to your site visitors.

Contact the Mokka support team at support@mokka.bg or your account manager. For activation, we will check all functions and hosted communication for compliance with the standards of the service.

Uninstalling

1. To uninstall the plugin go to "Plugins"-> "Installed Plugins" tab
   

2. Find the Mokka plugin in the list and click "Deactivate"

   
3. Then click "Delete".