Skip to content

4.1.7

Latest
Compare
Choose a tag to compare
@rohitcbr rohitcbr released this 16 Dec 12:03
304b4fc

Issues resolved

  • Bug fix in Callback
  • Added Entry in Razorpay config - "Pending Orders Maximum Age" for Cancel Pending Orders Cron
  • Readme update

NOTE:- Please perform proper E2E stage testing after installing/updating this version.

Install

Please select any one of below method, do not install using both methods together.
Razorpay Magento module can be installed using any of following methods:

  • Install through the "code.zip" file
  • Install through composer

If module is already installed using both methods then please uninstall one of installation and execute bin/magento setup:di:compile command to compile dependency code. Uninstall instructions are available with this document.

Install through the "code.zip" file

bin/magento is executable command, this is to be executed from Magento installation directory.

  1. Extract the attached code.zip
  2. Go to the "app" folder
  3. Overwrite content of the "code" folder with step one "code" folder (Note: if the code folder does not exist just place the code folder from step 1).
  4. Run following command to enable Razorpay Magento module:
bin/magento module:enable Razorpay_Magento
  1. Run following command to install Magento cron jobs :
bin/magento cron:install
  1. Run bin/magento setup:di:compile to compile dependency code.
  2. Run bin/magento setup:upgrade to upgrade the Razorpay Magento module from the Magento installation folder.
  3. On the Magento admin dashboard, open Razorpay payment method settings and click on the Save Config button.
    Note: If you see this message highlighted in yellow (One or more of the Cache Types are invalidated: Page Cache. Please go to Cache Management and refresh cache types.) on top of the Admin page, please follow the steps mentioned and refresh the cache.
  4. Run bin/magento cache:flush once again.

OR

Install through composer

Syntax for composer with version 1.x
composer require razorpay/magento <version>

Install the module through composer package manager.

composer require razorpay/magento 4.1.6
bin/magento module:enable Razorpay_Magento

Syntax for composer with version 2.x
composer require razorpay/magento:<version>

Install the module through composer package manager.

composer require razorpay/magento:4.1.6
bin/magento module:enable Razorpay_Magento

You can check if the module has been installed using bin/magento module:status

Execute following commands from Magento installation directory:

bin/magento setup:di:compile
bin/magento setup:upgrade
bin/magento cache:flush

Upgrade Razorpay plugin through composer

If you are an existing user, you can upgrade the Magento extension using the composer. Enter the command given below:

composer update razorpay/magento
bin/magento setup:upgrade

Note: If you have installed the plugin by following the "code.zip" steps, then you need to install latest code.zip file again.
Note: Please disable the Update Order Cron V1 from Razorpay Payment Method settings on Magento admin dashboard.

Setting up the cron with Magento

Setup cron with Magento to execute Razorpay cronjobs for following actions:

Cancel pending orders

It will cancel order created by Razorpay as per timeout saved in configuration if Cancel Pending Order is enabled.

Update order to processing

Accepts response from Razorpay Webhook for events payment.authorized and order.paid and updates pending order to processing.

Magento cron can be installed using following command:

bin/magento cron:install

Using Custom Order Status in Razorpay Magento

Step 1: Create Custom Order Status

  • On the Magento Admin Dashboard, Stores > Settings > Order Status.
  • In the upper-right corner, click on Create New Status.
  • Under Order Status Information section, Insert a Status Code for the internal reference. This field required to contain letters (a-z), the number (0-9) and the underscore, it is required to use letters at first character and the rest can be a combination of letters and numbers.
  • Set the Status Label for Admin and storefront.
  • Set the Store View specific labels for each store view on your store.
  • Save status to complete.

Step 2: Un-assign existing status

  • Un-assign existing status code which is in use.
    • If State Code and Title is processing[Processing], then processing status is already in use for state processing.
    • Un-assign this status from existing state code processing, so that state will be available for your custom status code.

Step 3: Assign an order status to a state

  • Go to the Order Status page, click on Assign Status to State button.
  • In the Assign Order Status to State section,
    • From the existing list of the order status, select the Order Status to assign.
    • Choose the Order State to include the order status you’ve just assigned. Use Order state as processing
    • Accept the order status as a default status, tick the Use Order Status as Default checkbox.
    • Enable the order status on the storefront, please tick the Visible On Storefront checkbox.
  • Click on Save Status Assignment to complete.

Step 4: Using Custom order status for Razorpay Magento

  • On the Magento admin dashboard, open Razorpay payment method settings.
  • At field Custom Paid Order Status select Yes to enable custom order status, select No to disable custom order status.
  • Insert Custom Paid Order Status value at input field provided with same value which has been used as Status Code while creating custom status.
  • Save configuration & refresh the cache.

Uninstall OR Rollback to older versions

To rollback, you will be required to uninstall existing version and install a new version again. Following are actions used for rollback & reinstall:

Uninstall Razorpay Magento

If composer is used for installation, use following commands from Magento installation directory to uninstall Razorpay Magento module

php bin/magento module:disable Razorpay_Magento
php bin/magento module:uninstall Razorpay_Magento

If code.zip is used for installation, to uninstall following steps can be used:
Disabled Razorpay Magento module

php bin/magento module:disable Razorpay_Magento

To remove module directory, execute following command from Magento install directory

rm -rf app/code/Razorpay

Remove module schema from MYSQL database

DELETE FROM `setup_module` WHERE `setup_module`.`module` = 'Razorpay_Magento';

Re-Install Razorpay Magento

To install Razorpay Magento module, follow installation steps provided at this release document. Following are previously released versions 3.7.5 and 4.1.5.