Magento 2 CCAvenue Payment Gateway

Magento 2 CCAvenue Payment Gateway extension integrates Magento 2 store with India's CCAvenue payment gateway to accept secure online payments from customers.

Table of Content

1. Extension Installation
2. Configuration
3. CCAvenue Payment Method in Frontend
4. CCAvenue Payment Details in 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-ccavenue-payment-gateway --ignore-platform-reqs
  • 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_Ccavenue --ignore-platform-reqs
      • • By default, the extension is probably disabled.
        • Enable the extension and clear static view files:
• • • php bin/magento module:enable Meetanshi_Ccavenue --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
   To configure the extension, login to Magento 2, move to Sales à Payment Methods à CCAvenue Payment - Meetanshi where you can find various settings to enable the extension.

• Enabled: Set “YES” to enable the CCAvenue Payment Gateway extension.
• Title: Set the title for the payment method to be displayed in the frontend.
• Show CCAvenue Logo: Set YES to show CCAvenue logo along with the payment method in the frontend.
• Sandbox Mode: Select YES to enable sandbox mode.
• Merchant ID: Enter merchant ID you received while regiration with the CCAvenue payment gateway.
• Access Code: Enter the access code you received while regiration with the CCAvenue payment gateway.
• Encryption Key: Enter the encryption key you received while registration with the CCAvenue payment gateway.

Note: Create an account on https://dashboard.ccavenue.com/web/registration.do, get the account approved, login to your account, move to Settings > API Keys and copy the merchant ID, access code and encryption key (working).

• Gateway URL: Enter the gateway URL. It will get auto filled on extension installation.
• Enable Debug: Set YES to enable debug.
• Allow Auto Invoice: Select YES to automate invoice generation for the orders paid using the CCAvenue payment method.
• Payment from Applicable Countries: Select countries to allow using this payment method.
• Minimum Order Total: Enter the minimum order amount for customers to meet to enable the payment method.
• Maximum Order Total: Enter the maximum order amount for customers to meet to enable the payment method.
• Additional Information: Enter the additional information to show on frontend along with the payment method.
• Sort Order: Enter Sort Order of the payment method display in the frontend.

3. CCAvenue Payment Method in Frontend
   Once the payment method is configured, whenever the customers add the products to cart and move to the checkout page, CCAvenue payment method is shown. They just select the payment method, click “Continue to Payment” to get redirected to the hosted payment page, add the payment details and complete the payment.

• Redirection to the CCAvenue Hosted Payment Page
  Once the customers get redirected to the CCAvenue hosted payment page, they select the payment method, payment option and click on the “Confirm Payment” button to finish the payment successfully.

• CCAvenue Payment Details in Customer’s My Account Section
  After the successful payment, customers can see the CCAvenue payment details in their My Account section.

4. CCAvenue Payment Details in Backend
   Apart from the customers, the admin can also see the payment details for the orders in the backend. Go to Sales à Orders à Order View to see the CCAvenue payment details along with the transaction ID, order status and tracking ID.