Magento 2 Surcharge or Additional Fee

Installation and User Guide for Magento 2 Surcharge or Additional Fee Extension

Table of Contents

1. Installation

   • Installation via app/code

   • Installation via Composer

2. Configuration Settings for Surcharge

   • General Settings

   • Surcharge for Multiple countries/Multiple payment methods

   • View Surcharge on the Order Details View Page

   • Surcharge for Admin Orders

3. Front-end Site View

   • Surcharge Percentage/Fixed Amount Per Payment Method and Country

   • View Surcharge on the Checkout Page

   • Surcharge with the Free Shipping

Installation

• Installation via app/code: Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

• Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.

Installation Via Composer

Configuration Settings for Surcharge

Go to Admin > Stores > Configuration > Scommerce Configuration > Surcharge

General Settings

• Enabled – Select “Yes” or “No” to enable or disable the module.

• License Key – Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at [e-mail].

• Surcharge Label – This label text gets used in the frontend of the website which will be shown on basket, review, invoice, order, shipment, email confirmation and refund.

• Surcharge Amount Type – This option allows you to choose fixed amount or percentage value. Percentage value gets calculated based on the grand total or subtotal attribute been selected.

• Surcharge Percentage or Fixed Amount – This is the surcharge or additional fee which will be shown to the customer based on surcharge amount type (fixed to percentage)

• Surcharge Percentage or Fixed Amount per payment method or payment method and country - Fixed or Percentage amount, additional fee will be applied based on grand or subtotal attribute been selected per payment method or payment method and country. Example checkmo:3;cashondelivery:2 or checkmo:3:FR;checkmo:5:GB

• Grand or Subtotal Attribute – This option allows you to choose whether you want to apply percentage additional fee on grand or subtotal. This will also apply on Minimum Order Total.

• Minimum Order Total – This value will be checked / validated based on the

Grand or Subtotal Attribute value been selected.

• Skip with Free Shipping – This option can be used if you don’t want to charge additional fee when the shipping price is zero. This is useful when you are charging additional fee based on the shipping country but when the shipping is free then you might not want to charge additional fee.

• Tax Class - Please select the tax class from the drop-down list.

• Shipping Countries – The additional fee will be applied only to the specific shipping country(s). Please select all if you want to charge additional fee for all shipping countries.

• Payment Method – The additional fee will be applied only to the specific payment method (s). Please select all if you want to charge additional fee for all payment methods.

Please select the Payment Method, surcharge will be applied only for the selected payment method

• Surcharge for Multiple countries/Multiple payment methods - You can set surcharge for multiple countries by selecting countries from Admin > Stores > Configuration > Scommerce Configuration > Surcharge > General Settings > Shipping Countries, and multiple payment methods from Admin > Stores > Configuration > Scommerce Configuration > Surcharge > General Settings > Payment Method.

• View Surcharge on the Order Details View Page - You can see the applied surcharge on the order details view page from Admin > Sales > Orders > Select Order > Edit , under "Order Totals" section.

• Surcharge for Admin Orders - In the below image you can see the added surcharge value for the order placed from the admin panel, Admin > Sales > Orders > Create New Order > Select User > Select Product > Add Product.

Front-end Site View

• Surcharge Percentage/Fixed Amount Per Payment Method and Country When you set "Surcharge Percentage or Fixed Amount per payment method and country" to "checkmo:3:FR" from Admin > Stores > Configuration > Scommerce Configuration > Surcharge > Surcharge Percentage or Fixed Amount per payment method, then the fixed or Percentage amount, additional fee will be applied based on grand or subtotal attribute been selected per payment method or payment method and country.

• checkmo:3:FR - It will add 3% additional fee on "Subtotal Including Tax" , will be applied for shipping country France and payment method Check Money order.

• checkmo:5:GB - It will add 5% additional fee on "Subtotal Including Tax" , will be applied for shipping country UK and payment method Check Money order.

• checkmo:3 - It will add 3% additional fee on "Subtotal Including Tax", and will be applied only for Check Money Order payment method and shipping countries selected from Admin > Stores > Configuration > Scommerce Configuration > Surcharge > Shipping Countries .

• Set Different Surcharge for Countries - You can set different surcharge for countries from Admin > Stores > Configuration > Scommerce Configuration > Surcharge > Surcharge Percentage or Fixed Amount per payment method - checkmo:3:FR;checkmo:5:GB.

• View Surcharge on the Checkout Page - When you select "Surcharge Amount Type" to "Percentage" , " Surcharge Percentage or Fixed Amount " to "10" and " Payment Method " to "Cash On Delivery"/"Check Money order" from Admin > Stores > Configuration > Scommerce Configuration > Surcharge, then it adds 10 % additional fee on "Subtotal Including Tax" based on selected payment method and shipping countries. To add shipping countries go to Admin > Stores > Configuration > Scommerce Configuration > Surcharge > Shipping Countries - Select Shipping Countries from the drop-down list.

• Surcharge with the Free Shipping - You can skip surcharge for the free shipping orders from Admin > Stores > Configuration > Scommerce Configuration > Surcharge > Skip with Free Shipping - "Yes". This option can be used if you don’t want to charge additional fee when the shipping price is zero.

If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact [e-mail].