Magento 2 FreeCharge Payment Gateway

Table of Contents

1. Extension Installation Guide
2. Configuration
3. FreeCharge Payment Method in Frontend
4. FreeCharge Payment Details in Sales Order View Backend
5. Refund Online for FreeCharge Orders from Backend

1. Extension Installation
   • For Magento Marketplace Customers
     • Find the Composer name and version of the extension in the extension’s composer.json file.
     • Login to your SSH and run:

• • • composer require meetanshi/magento-2-freecharge-payment-gateway

• • Enter your authentication keys. Your public key is your username; your private key is your password.
  • Wait for Composer to finish updating your project dependencies and make sure there aren’t any errors.
  • To verify that the extension installed properly, run the command:
    • php bin/magento module:status Meetanshi_Freecharge
      • • By default, the extension is probably disabled.
        • Enable the extension and clear static view files:
    • php bin/magento module:enable Meetanshi_Freecharge --clear-static-content
    • php bin/magento setup:upgrade
    • For Magento version 2.0.x to 2.1.x - php bin/magento setup:static-content:deploy
    • For Magento version 2.2.x & above - php bin/magento setup:static-content:deploy –f
    • php bin/magento cache:flush

• • For Meetanshi Customers
    • Extract the zip folder and upload our extension to the root of your Magento 2 directory via FTP.
    • Login to your SSH and run below commands step by step:
      • php bin/magento setup:upgrade
      • For Magento version 2.0.x to 2.1.x - php bin/magento setup:static-content:deploy
      • For Magento version 2.2.x & above - php bin/magento setup:static-content:deploy –f
      • php bin/magento cache:flush

2. Configuration
   For configuring the extension, login to Magento 2, move to Stores à Configuration à Sales à Payment Methods à FreeCharge Hosted Payment – Meetanshi where you can find various settings to enable the extension.

• Enabled: Enable FreeCharge Payment Gateway extension from here.
• Title: Enter title for the FreeCharge payment method to show in the frontend.
• Show FreeCharge Logo: Select YES to show FreeCharge logo on the checkout page in frontend.
• Sandbox Mode: Set YES to enable sandbox mode for the payment gateway.
• Merchant ID: Enter the merchant ID received while registration with FreeCharge.
• Merchant Key: Enter the merchant key received while registration with FreeCharge.
• Allow Auto Invoice: Set YES to auto generate invoice for the FreeCharge orders.
• Order Status: Set status for the new orders placed through FreeCharge payment method.
• Payment from Applicable Countries: Select all or selected countries to allow payments using FreeCharge.
• Payment from Selected Countries: If you have set selected countries from the above option, select the countries to allow payments using FreeCharge.
• Additional Information: Enter additional information to show on the checkout page in the frontend.
• Debug: Select YES to enable debug.
• Sort Order: Enter sort order of the payment method.

3. FreeCharge Payment Method in Frontend
   Once the extension is configured, it can be seen enabled in the frontend. Simply add products to cart and go to the checkout, you can see the FreeCharge Payment method enabled. Select the payment method, click “Place Order” button.

• On click of “Place Order” button, the user get redirected to the FreeCharge hosted payment page where he selects one of the payment methods, enter the payment details and click “Pay” to pay successfully for the order.

• FreeCharge Payment Details in My Account Section
  Immediately after the order is placed, the FreeCharge Payment details can be seen in order view tab under the customer’s My Account section.

4. FreeCharge Payment Details in Sales Order View Backend

Apart from the customer’s My Account section, the admin can also see FreeCharge payment details from the Sales à Orders à Order View section in the backend.

5. Refund Online for FreeCharge Orders from Backend

The extension is compatible with online refund through FreeCharge payment method. Admin can simply move to Sales > Invoices > View Invoice, click on “Credit Memo” button, while creating a new credit memo, click on “Refund” button to refund online through FreeCharge payment method for your order.