README.md

Shopware 6 plugin for Lunar

The software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement.

Supported Shopware versions

The plugin has been tested with most versions of Shopware at every iteration. We recommend using the latest version of Shopware, but if that is not possible for some reason, test the plugin with your Shopware version and it would probably function properly.

Features

• Automatic capture/refund/cancel on order payment status change
• Automatic check for unpaid orders using cron (task scheduler)

Automatic installation

Once you have installed Shopware, follow these simple steps:

1. Sign up at lunar.app (it’s free);
2. Create an account;
3. Create app/public keys pair for your Shopware website;
4. Upload the plugin archive trough the /admin#/sw/extension/my-extensions/listing page (Upload extension button) or follow the steps from Manual installation section bellow.
5. Activate the plugin from /admin#/sw/extension/my-extensions/listing page;
6. Insert your app and public keys in the plugin settings (<DOMAIN_URL>/admin#/lunar/payment/settings/index).
7. Change other settings according to your needs.

Manual installation

1. Download the plugin archive from this repository releases;

2. Login to your Web Hosting site (for details contact your hosting provider);

3. Open some kind File Manager for listing Hosting files and directories and locate the Shopware root directory where is installed (also can be FTP or Filemanager in CPanel for example);

4. Unzip the file in a temporary directory;

5. Upload the content of the unzipped extension without the original folder (only content of unzipped folder) into the Shopware <SHOPWARE_ROOT_FOLDER>/custom/plugins/ folder (create empty folders "/custom/plugins/LunarPayment" if needed);

6. Login to your Shopware Hosting site using SSH connection (for details contact our hosting provider);

7. Run the following commands from the Shopware root directory:

      bin/console plugin:refresh
      bin/console plugin:install --activate LunarPayment
      bin/console cache:clear
   

8. Open the Shopware Admin panel;

9. The plugin should now be auto installed and visible under /admin#/sw/extension/my-extensions/listing page;

10. Insert the app key and your public key in the plugin settings (<DOMAIN_URL>/admin#/lunar/payment/settings/index).

11. Change other settings according to your needs.

Updating settings

Under the Shopware Lunar payment method config (/admin#/sw/extension/my-extensions/listing), you can:

• Activate/deactivate the plugin
• Uninstall the plugin

Under the Shopware Lunar payment method settings (/admin#/lunar/payment/settings/index), you can:

• Add app & public keys
• Change the capture mode (Instant/Delayed)
• Update shop title that shows up in the hosted checkout page
• Enable/disable plugin logs

Under the Shopware Lunar payment method Shop settings, you can:

• Activate/deactivate plugin payment methods
• Update frontend payment methods name
• Update frontend payment methods description
• Update frontend payment methods logo
• Update frontend payment methods list order
• Allow payment methods to be available when change payment method by customer (not available for the moment in this plugin)
• Establish availability rule for payment methods

How to

1. Capture
   • In Instant mode, the orders are captured automatically
   • In delayed mode you can press Capture button from Order details page, Lunar Payment tab.
   • Also, the order can be Captured by changing the payment status from Authorized to Paid.
2. Refund
   • To refund an order you can press Refund button from Order details page, Lunar Payment tab
   • Also, the order can be Refunded by changing the payment status from Paid to Refunded.
3. Cancel
   • To cancel an order you can press Cancel button from Order details page, Lunar Payment tab
   • Also, the order can be Canceled by changing the payment status from Authorized to Canceled.

Available features

1. Capture
   • Shopware admin panel: full capture
   • Lunar admin panel: full/partial capture
2. Refund
   • Shopware admin panel: full refund
   • Lunar admin panel: full/partial refund
3. Cancel
   • Shopware admin panel: full cancel
   • Lunar admin panel: full/partial cancel

Changelog

2.2.0 - Added logo URL validation

2.1.0 - Enabled cron & added enable/disable logs switch

2.0.0 - Switched to hosted checkout flow & added MobilePay payment method

1.1.0 - Compatibility with Shopware 6.5

1.0.0 - Initial version