Modified Shop Plug-in Documentation
Compatible with: 1.06 - 2.0.x
Checklist
The following steps are necessary to implement the Micropayment payment modules. All the details on how to integrate them are covered in later sections of this manual.
- 1
Sign up for free of charge and without obligation in the Micropayment ControlCenter.
- 2
Use the Micropayment merchant access to create your project(s) under
Configuration → Projects. The registered projects are reviewed by our risk team as quickly as possible. - 3
Activate your project. After you have applied all the settings, all payment methods will be available in test mode.
- 4
Request the required payment methods via
Customer data → Contract information → Payment methods. - 5
Configure the desired payment methods under
Configuration → Payment methods. - 6
After your account has been authenticated, our service will be fully available to you for LIVE operation.
You can use all payment methods in test mode at any time. If you have any questions, our Support Team is always happy to help.
Installation
To install the payment modules, you will need to access the shop software files.
Connect to your web server’s file system for this, for example via FTP.
Begin installation:
PLEASE BACKUP YOUR ENTIRE SHOP DIRECTORY AND DATABASE.
Note:
To install the payment modules, you will need to access to the shop software files. Connect to your web server’s file system for this, for example via FTP.
Start installation:
Copy all files from the zip folder (without changing the directory hierarchy) to your shop’s main directory. This will not overwrite existing files from the Oxid e-commerce software.
Exception:
If you have a previously installed micropayment™ module, please delete it BEFORE you install the new module!
- 1
Connect to your web server’s file system, e.g. via FTP.
- 2
Extract the module folder to your computer.
- 3
Then load the content into the main directory of Modified. The directories “callback, images, includes and lang” should be overwritten. NO existing files will be overwritten.
- 4
Now there should be a “micropayment” folder in the “callback” folder.
- 5
Log into the admin area of your shop and navigate to the Modules → Payment options selection.
- 6
The modules of Micropayment should be displayed there now. The modules are called “Micropayment Credit card, Micropayment Direct debit, Micropayment Instant bank transfer and Micropayment Prepayment”.
- 7
Select the desired module, right-click on “Install” and then click on “Edit” to configure the module as follows:
Configure the payment methods in the Modified backend
Once you’ve installed the respective module, you still have to change a few options for it to function properly. To do this, go to the administration area of the shop and select the module for which you want to adjust the options under “Modules -> Payment options”.
Button: Clean up order
A button that deletes all orders with the status “Payment outstanding” that are X days old. This allows you to manually remove non-completed orders with ease.
Settings for the individual fields in the Micropayment configuration mask:
Status
Activate (True) the payment module here to make it available in the shop.
Minimum order value
Enter the minimum order value here. Or enter 0 for no minimum order.
Maximum order value
Enter the maximum order value here. Or enter 0 for no maximum order.
Sort payment methods
Enter the position for the payment method to be displayed in the shop here. 1 is the top position; the higher the number, the lower down the payment module will be displayed.
Country selection
Enter the countries for which the payment module is available here. If you want to enter several countries, separate each country with a comma, e.g.: de, en. If you don’t want apply any restrictions, leave the field blank.
Account ID:
Enter your 5-digit account ID for Micropayment here.
Project ID
Open the project in the Micropayment ControlCenter under Configuration → Projects and copy the project ID listed there.
Access key
You can find the access key in the Micropayment ControlCenter under Configuration → Access key.
Test mode
Activates or deactivates test mode
Free text / payment reference
Description of the order for the customer’s payment reference. If left blank, only the order number [orderId] will be used. Optionally, you can add your own text. Example: “[orderId] - Your order from www.your-shopurl.com”.
Theme template
The themes X1 (default) or X2 are available for to be displayed for redirections. You can find more information in the Micropayment ControlCenter under
Help → Payment window & themes.
Micropayment domain
depending on your Micropayment account number, select Micropayment GmbH (.de) from numbers ranging from 0-49999 orMicropayment AG (.ch) for numbers ranging from 50000-99999.
Logo in the payment window
You can store your own logos (Theme X1 only) in the Micropayment ControlCenter (Tools → Payment window images) and enter the gfx code here.
Background colour
Enter a different colour code (hex value) here if required. You can find more information in the Micropayment ControlCenter under
Help → Background image.
Background image
Set the background image for redirections here. You can find more information in the Micropayment ControlCenter under
Help → Background image.
Secret word / security field
You can find the secretfield in the Micropayment ControlCenter under
Configuration → Payment methods → Payment method event → Configure project → Parameters: Notification URL → Edit option
Delete unpaid orders:
How long can an order have the “Payment outstanding” status before it is removed by the “Clean up order” button? This is used to determine how old unpaid orders need to be in order to be removed by the “Button: Clean up order”. Settings between 3-30 days are allowed.
Security field name
You can assign a custom field name here, which will be used for the notification API in order to secure communication between the servers. Lower case letter and numbers are allowed. If you decide to use your own field name, please also make sure to update the GET parameter in the micropayment™ ControlCenter. If not, “secretfield” will be used.
Security field value
Please enter a random value here. It must be at least 5 characters long and also needs to be stored as a GET parameter in the ControlCenter. The characters a-z, A-Z and 0-9 are allowed.
Order status Payment outstanding.
(Default: Payment outstanding)
Select the status to be applied to an order during the payment process here.
Order status paid.
(Default: In process)
Select a status here that an order receives as soon as the customer has paid and the money has been received by micropayment™.
Order status Cancelled.
(Default: Cancelled)
Select a status here that will be applied to an order as soon as a cancellation of a payment is received.
Order status: Review payment
(Default: Review payment)
This status is applied if there are problems with the payment so that you can review it.
Order status: Conflict
(Default: Event problem!)
This status is applied in the event of conflicts in the payment process.
Order status: Prepayment – partial payment
(Default: Prepayment, partial payment)
This status is applied if an incoming payment is flagged for prepayment, but the amount due has not been paid in full.
Shop installation complete!
You have now completed all the settings in your shop software. As a last step, please apply important settings in the Micropayment ControlCenter. After completing these settings, you can use the Micropayment payment modules.
Payment method configuration in the Micropayment ControlCenter
Credit card / SEPA direct debit / prepayment
Micropayment - Project settings
Before you can use the Micropayment payment plug-in, you have to apply some settings in the Micropayment ControlCenter.
Note:
Settings must be applied for all payment methods you intend to use. Credit card, SEPA direct debit and prepayment have different configurations from the other payment methods.
Configure payment method:
To configure the payment method, go to Configuration → Payment methods and select Credit card → API.Event / Direct debit → API.Event / Prepayment → API.Event.
Notification URL:
Enter the following notification URL here:
Direct debit
https://www.shopurl.de/root-of-shop/ 
CreditCard
https://www.shopurl.de/root-of-shop/ 
Bank Transfer
https://www.shopurl.de/root-of-shop/ 
Activate the payment method
To do this, click on “Information on using the API” and agree to the information. Save your settings.
Access authorisation
You need to authorise communication between your shop and Micropayment. To do this, open Configuration → Access authorisations and then select “New access authorisation”. Enter the IP address of your shop server here.
Payment methods
All payment methods that you want to use in the shop must be configured and activated. Please select the event option for the other payment methods (e.g. SOFORT - Event, paysafecard - Event etc.).
Activate the desired payment method
Enter your shop URL as the API URL: https://shopurl.de/root-of-shop/
Please enter the following values for these payment methods under “Parameter: Notification URL”.
| Name | Value | |
|---|---|---|
| orderid | = | __$orderid__ |
| Name | Value | |
|---|---|---|
| orderid | = | __$orderid__ |
| Name | Value | |
|---|---|---|
| orderid | = | __$orderid__ |
| Name | Value | |
|---|---|---|
| orderid | = | __$orderid__ |
| Name | Value | |
|---|---|---|
| orderid | = | __$orderid__ |
| Name | Value | |
|---|---|---|
| orderid | = | __$orderid__ |
| Name | Value | |
|---|---|---|
| orderid | = | __$orderid__ |
| Name | Value | |
|---|---|---|
| orderid | = | __$orderid__ |
| Name | Value | |
|---|---|---|
| orderid | = | __$orderid__ |
Options → API URL: Activate the sending of additional data here.
Advanced security: Enable this option.
Test mode: Activate / Deactivate - must be active if you want to carry out test orders in your shop module. You can find the test data generated here in the Micropayment ControlCenter under Help → Test mode.
https://www.shopurl.de/warenkorb/ Activate/Deactivate
Activates the payment method in the Shop System → Settings → Sales / Payment methods.
The configuration in the Micropayment ControlCenter has been completed.
We hope you enjoy your Micropayment plug-in.
General notes
Payment via the Micropayment modules can be made in the currency € (EUR). If you offer other currencies in your shop, this value will be converted, or for payment via credit card, a currency terminal must be requested.
Payment status: Initiated payment with Micropayment
The customer has initiated an order. An order can have this status permanently if the customer leaves the payment window and does not complete the payment process.
Payment status: Prepayment, outstanding. Deadline till year-month-day
Order was placed with prepayment. This is displayed if no payment has been received for a prepayment order. The date displayed here indicates when the prepayment order expires.
Payment status: Payment complete. 00.00 EUR Auth xxxxxxxxxxxxxx
Order has been paid. The payment amount and the internal Micropayment authentication key are shown. This can be used in the ControlCenter to process the payment.
You can find payment modules for other shops on our website at Payment Plug-ins for your Online Shop
Custom image for your payment window
You have the option to save a custom 200x200px image in the Micropayment payment window. This image is accessed via an image code. You can upload it in your Micropayment ControlCenter under the menu option Tools → Payment window images. In the following step, the generated code (ID) is stored in your configuration as an image code.
Integration made easy.
Do you have questions about our payment methods or about the use of our systems? Please contact us by e-mail. We will reply as soon as possible.
(0800) 5 770 371
free of charge from German landline
-
helpdeskCarsten Keßel
senior support engineer
-
finance officeJessica Amberg
head of controlling
-
helpdeskRobert Kühn
senior support engineer
