WooCommerce

Overview

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

Installation

The module can be manually installed in the admin panel 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 click the button "Upload Plugin".

3. Upload 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 in the menu: "WooCommerce"-> "Plugins"-> "Mokka payment".

Settings

1. Go to the menu “WooComerce" -> "Mokka payment".
2. The tab "API settings" will be displayed. Here you can fill 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 team. 
   • Base URL address - the default URL for production Mokka connection.
   • Store ID (Test mode) and Secret key (Test mode) - parameters issued by Mokka team for the sandbox mode for testing and debugging. 
   • Base URL address (Test mode) - the URL for connecting to the test environment. By default - https://stage-backend.mokka.ro
   • Orders page - the link for a quick navigation to 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 according to your tariff.
   • Maximum Order Value - to be set up according 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 where the site is located.
   • Generate invoice after Mokka accepted payment - the setting for generating a receipt after approval of Mokka advance for the client.
   • Show for all deliveries - the setting for displaying Mokka payment method at the checkout
   • optional parameters:
   • Sort Order - position for the payment in the list.
   • Show for all deliveries - selecting will make the payment method available for all shipping options.
   • Shipping methods –  list of shipping options for which the payment method will be available.
     
     
4. Go to the tab "Statuses" for mapping statuses values.
   • Сanceled orders - the status that requests cancellation of the order from Mokka service.
   • Finalized orders - the status that requests finalization of the order from Mokka service. Usually, this  status is set after the shipment of the order is completed.
   • New order - the status is 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 status that requests a return of the order from Mokka service.
   • Approved orders - the status is applied to the order after an approval from the payment system. The order has already been completed, but is not finalized yet.
   • Declined orders -the status is applied to the order after a rejection 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 using the default logos, embedded into the plugin package.
   
   • Widget display type - selection of the 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 external URL.

   • 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 - a message 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 according to your tariff.
   • Minimum number of loan months - to be set up according to your tariff.
   • Widget display type - selection of the displayed template.
   • 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. They allow 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 the plugin sends 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.
     
8. Then scroll down and click "Save settings"
   

Testing

Checkout

1. Add products to the cart to reach the required minimum amount.
2. Go to the cart.
3. Select "Mokka - advance payment" in the payment methods.
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 clicking the checkbox next to the 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 clicking the checkbox next to the 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 finishing the testing, activate the module so that the Mokka team can check 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.

Contact Mokka support team at support@mokka.ro or your account manager. For activation, we will schedule a call for live testing of all functions and guidelines.

Uninstalling

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

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

   
3. Then click "Delete".