Quickstart guide

Oxid eSales Plug-in Documentation

plugin version: 1.1
Compatible with: 4.x

Oxid Shop-Plugin

Available payment methods for this shop version:

payment plugin

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 BACK UP YOUR ENTIRE SHOP DIRECTORY AND DATABASE.

To install the payment modules, you need to access 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 ecommerce 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, for example via FTP.
2
Extract the module folder to your computer.
3
Then load the content into the main directory of Oxid.
4
The folder
""modules/Micropayment/payment""
should be available there now.
5
Log into the admin area of your shop and navigate to the “Module extensions” page (Extensions → Modules).
6
The Micropayment modules should be displayed there now. The module is called ""Micropayment GmbH"".
7
Click on the module and then right-click on “Activate”.
8
Now click on “Settings” to configure the module.

Configure the payment modules in the OXID shop backend

The following options can be selected

Settings for the individual fields in the Micropayment configuration mask:

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.

Micropayment plug-in configuration settings

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: #Order#.

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

Security field
You can assign a custom field name here, which will be used for the notification API in order to secure communication between the servers. Only lower case letters 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. You can also use the automatically generated value.

Security 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.

Billing URLs
This value is created automatically, so you don’t need to change the billing URL.

Update interval
This is used to determine how often the module retrieves info data from the Micropayment server. No changes required.

Last updated
This shows the last time info data was retrieved. No changes required.

Navigate to the payment methods under “Shop settings → Payment methods”.

Activate and configure the payment methods as required. Please don’t forget to assign the user groups, countries and delivery options to the payment method.

Payment methods are called Credit card, Direct debit, Instant bank transfer and Prepayment. Micropayment payment methods are identifiable by the “description of the payment method”.

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.

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/

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.).

Payment method configuration in the Micropayment ControlCenter

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__`
cl	=	`micropayment_callback`

Name		Value
orderid	=	`__$orderid__`
cl	=	`micropayment_callback`

Name		Value
orderid	=	`__$orderid__`
cl	=	`micropayment_callback`

Name		Value
orderid	=	`__$orderid__`
cl	=	`micropayment_callback`

Name		Value
orderid	=	`__$orderid__`
cl	=	`micropayment_callback`

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.

Error & abort URL: Enter your URL for the checkout here https://www.shopurl.de/warenkorb/

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

Micropayment - Order summary

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.