Fatchip GmbH Wiki

Diese Seite ist nicht editierbar. Sie können den Quelltext sehen, jedoch nicht verändern. Kontaktieren Sie den Administrator, wenn Sie glauben, dass hier ein Fehler vorliegt.
====== OXID Plugin - Mollie Payments ======
for Oxid 6

===== Requirements =====

  * Oxid eShop Version 6 or above
  * Mollie Account (www.mollie.com)
  * FTP access to your shop system
  * For OXID versions from 6.2. you need SSH access to the shop installation.

----

==== Installation ====

  * Change to the directory "source/modules" in your OXID eShop installation and create the directory "mollie"
  * In this directory create a sub-directory "molliepayment" and change to it. You find yourself in the path "source/modules/mollie/molliepayment" now.
  * Use a Git or SVN client to check out the module-files or download the ZIP-file https://github.com/mollie/mollie-oxid/archive/master.zip and extract its content to this directory.
  * Open the file **composer.json** in the root-directory of your shop and add this autoload-configuration or add/complete an existing configuration with the following:
<code javascript>
  "autoload": {
    "psr-4": {
      "Mollie\\Payment\\": "./source/modules/mollie/molliepayment"
    },
    "files": ["./source/modules/mollie/molliepayment/lib/mollie-api-php/vendor/autoload.php"]
  },
</code>

  * Open a command-line on your webserver and execute the following command to regenerate the autoloader-files:

  vendor/bin/composer dump-autoload

  * **In OXID versions from 6.2 on (older versions can skip this step)** you must now import the module configuration. To do this, log in via SSH to the server on which the shop installation is located and navigate to the directory in which the source and vendor folders are located. Execute the following command: 

  ./vendor/bin/oe-console oe:module:install-configuration source/modules/mollie/molliepayment/ 

You should then receive the message Module configuration has been installed.

  * Login to the OXID-admin of your shop and see the module "Mollie Payment" in the list of modules at //Extensions -> Modules//

{{:public:mollie_aktivieren.png?nolink&400|}}

  * Click on "activate" in case you find the module still being deactivated.

----

==== Configuration ====
The configuration options of the Mollie Payment module are available in the OXID-admin here: //Extensions -> Modules -> Mollie Payment -> tab "Settings"//\\ \\ 
{{:public:mollie_konfiguration.png?nolink&400|}}

{{:public:mollie_konfiguration_details.png?nolink&400|}}

^  no. ^ configuration option ^ description ^
|  1  |"Mode": "Test" or "Live"|choose if you're still testing or already run the shop live / in production-mode|
|  2  |"Test API Key"|paste here the "Test API Key" you can find in your Mollie account|
|  3  |"Live API Key"|paste here the "Live API Key" you can find in your Mollie account| 
|  4  |"Log result of transaction handling"|choose to log the result of transactions being performed|
|  5  |"Remove deactivated payment types"|choose not to display payment types which haven't been activated in the Mollie account|
|  6  |"Show icons"|display the icons of the payment types|
|  7  |"Status Pending"|set the order-status before the customer gets redirected to the payment-gateway|
|  8  |"Status Processing"|set the order-status for completed payments|

----

==== Usage ====

Activate payment-types as usual at //Shop Settings -> Payment Methods//. You see if a payment-type is provided by Mollie by selecting it with a click on a list-item, e.g. to "Belfius" or "Credit card". You'll get displayed "This is a Mollie payment type" on top in the tab "Main". It will be displayed, too, if a Mollie payment-type is not activated.

{{:public:mollie_zahlart.png?nolink&400|}}

As soon as the payment-types are correctly configured in your Mollie Account and the OXID-Admin they are available in the checkout of your online-shop.

----

==== Activation ====
of Mollie Components for credit card

To allow the customers to enter their credit card data without leaving your online-shop you have to 
  * select the payment-type "Credit Card"
  * choose from the selectbox "Creditcard data": "Input in shop checkout with iframe form inputs".

{{:public:molliecreditcardcomponents.png?nolink&400|}}

----
==== Cronjobs ====
The Mollie module includes a cronjob script which is able to execute certain tasks of the Mollie module periodically.
For those periodic tasks to work you have to configure a cronjob on the webserver of your OXID eShop.
The cronjob script can be found here:
  {PATH TO YOUR SHOP}/source/modules/mollie/molliepayment/cron.php
This cronjob main script starts all sub-jobs included in the Mollie module.
You can configure the minute interval in which you want the sub-jobs to run in the database table "molliecronjob".
You can enable or disable certain sub-jobs in the module configuration in the Cronjobs group.

The Mollie module has the following sub-jobs currently:

  * OrderExpiry: Orders with pending payments can be cancelled automatically after a certain time. You can configure this timespan in the configuration for each Mollie payment method in the OXID backend. You can select a timespan between 1 and 30 days or deactivate this for each payment method.

More sub-jobs will be added in the future.
==== FAQ ====

  - [[#Where can I see orders in the backend?]]
  - [[#Where can I see refunds in the backend?]]
  - [[#Where can I see shipping information/ship items in the backend?]]
  - [[#Where can I find the settings of the Mollie plugin?]]
  - [[#Are the shipping information transfered to mollie?]]
  - [[#What settings are possible within the backend?]]
  - [[#Where can I find the logs?]]
  - [[#What are the basic things to check while debugging?]]
  - [[#What are the installation instructions?]]
  - [[#What are the update instructions?]]


=== 1. Where can I see orders in the backend? ===

  - Login to the OXID-Admin.
  - Click on the elements as shown in the screenshot below to
    - Open the menu “Administer Orders”
    - Select the menu entry “Orders”
    - Select a specific order
    - See the tab “Overview” (opened by default)
    - See the tab “Main” a.s.o.

{{:public:mollie_faq_1.png?nolink&400|}}

=== 2. Where can I see refunds in the backend? ===
  - Login to the OXID-Admin.
  - Click on the elements as shown in the screenshot below to
    - Open the menu “Administer Orders”
    - Select the menu entry “Orders”
    - Select a specific order
    - See the tab “Mollie”, here the refund-functions are provided.

{{:public:mollie_faq_2.png?nolink&400|}}

=== 3. Where can I see shipping information/ship items in the backend? ===
In Question 1. and 2.is already described how to get in the OXID-Admin to the place where information about an order can be found. The tabs (numbered with 4 to 10) mentioned in question 1. will be described one by another below.

{{:public:mollie_faq_3.png?nolink&400|}}
 
  - Overview gives a general overview to the order. 
    - To whom? 
    - What? 
    - Price / sum calculation
    - Status of payment and shipment
    - Information for internal organization
    - Shop-wide overview
    - Shipping-information / setting /sending
  - Main gives a deeper look at
    - Order/Invoice-number
    - Payment
    - Shipping
  - Addresses shows
    - Invoice-address
    - Shipping-address
  - Products shows
    - an editable list of the ordered products
    - a calculation / sum for this order
  - History is of no real use and can be safely ignored
  - Downloads shows information about download-products contained in this order.
  - Mollie (see question 2.) allows the admin to
    - perform a full refund of the whole order-sum or
    - to perform a partial refund on order-position-base

=== 4. Where can I find the settings of the Mollie plugin? ===
  - Login to the OXID-Admin.
  - Click on the elements as shown in the screenshot below to
    - Open the menu “Extensions”
    - Select the menu entry “Modules”
    - Choose “Mollie Payments”
    - Click on the tab “Settings”
    - Click on “Basic configuration” to get the settings displayed

{{:public:mollie_faq_4.png?nolink&400|}}

=== 5. Are the shipping information transfered to mollie? ===
If you are using the plugin version 1.0.9 or higher, the information will be send to mollie after you saved the shipping information in OXID.\\
Please update to the latest plugin version, if you using a version smaller than 1.0.9 to use this feature.

=== 6. What settings are possible within the backend? ===
See the question 4. to get to the settings for the Mollie Payment module.

{{:public:mollie_faq_5.png?nolink&400|}}

^  No.  ^ configuration-option ^ description ^
|  1  |„Mode“: „Test“ or „Live“|choose if you're still testing or already run the shop live / in production-mode|
|  2  |„Test API Key“|paste here the „Test API Key“ you can find in your Mollie account|
|  3  |„Live API Key“|paste here the „Live API Key“ you can find in your Mollie account|
|  4  |„Log result of transaction handling“|choose to log the result of transactions being performed|
|  5  |„Remove deactivated payment types“|choose not to display payment types which haven't been activated in the Mollie account|
|  6  |„Show icons“|display the icons of the payment types|
|  7  |„Status Pending“|set the order-status before the customer gets redirected to the payment-gateway|
|  8  |„Status Processing“|set the order-status for completed payments|

=== 7. Where can I find the logs? ===
There is a logging accessible for technically enabled users which have access to the MySQL-database of the shop. These can access the table “mollierequestlog” and read the request / response logging being written there.

=== 8. What are the basic things to check while debugging? ===
  - Try to reproduce the problem in the demo-shop, i.e. go to https://demoshop.rocks/, currently you find here
    - https://ox611.mollie.demoshop.rocks/ respectively
    - https://ox611.mollie.demoshop.rocks/admin and try out if the problem exists here, too.
  - Check the configuration and settings (see question 4 above). Make sure the “Live API Key” is the one the client/merchant is supposed to use.
  - If you’re technically able: Check the table “mollierequestlog” (see qestion 6 above)in the database for helpful information.
  - If you don't get the problem solved yourself feel free to contact support@fatchip.de.

=== 9. What are the installation instructions? ===
  - Change to the directory „source/modules“ in your OXID eShop installation and create the directory „mollie“.
  - In this directory create a sub-directory „molliepayment“ and change to it. You find yourself in the path „source/modules/mollie/molliepayment“ now.
  - Use a Git or SVN client to check out the module-files or download the ZIP-file https://github.com/mollie/mollie-oxid/archive/master.zip and extract its content to this directory.
  - Open the file composer.json in the root-directory of your shop and add this autoload-configuration or add/complete an existing configuration with the following:
    <code>
"autoload": {
  "psr-4": {
    "Mollie\\Payment\\": "./source/modules/mollie/molliepayment"
  },
  "files": ["./source/modules/mollie/molliepayment/lib/mollie-api-php/vendor/autoload.php"]
}</code>
  - Open a command-line on your webserver and execute the following command to regenerate the autoloader-files: vendor/bin/composer dump-autoload
  - Login to the OXID-admin of your shop and see the module „Mollie Payment“ in the list of modules at Extensions → Modules and click on „activate“ in case you find the module still being deactivated.

{{:public:mollie_faq_6.png?nolink&600|}}

=== 10. What are the update instructions? ===
  - Make a backup of all the shop files. Do not proceed before a complete backup is created and stored locally.
  - See the installation instructions in question 8. 
  - Copy the files being addressed in 8.3. to their destination and overwrite the existing files with the new ones.
  - See 8.6.: Go to the OXID-Admin and click the button “Deactivate” and after it changed to “Activate” click it again.
  - Check the settings and configuration in the OXID-Admin.
  - Test the Mollie Payment in the frontend, i.e. perform a test-order for each activated Mollie payment-method.

----

====Support====

If you need help from FATCHIP, please send a detailed error description including plug-in and shop version to //support@fatchip.de//.
Fatchip GmbH Wiki

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Seiten-Werkzeuge
