Skip to main content

EBICS

With the plugin EBICS, you integrate EBICS (Electronic Banking Internet Communication Standard) into your system. To do so, download the EBICS plugin from the plentyMarketplace . To set up EBICS you have to carry out a few basic settings in your plentymarkets system.

EBICS (Electronic Banking Internet Communication Standard) is a transmission protocol for banking information for usage by banking clients. With the help of the standardised EBICS procedure, retrieving payments has become even easier. This plugin completely integrates EBICS in plentymarkets. No third party providers are required.

For communication via EBICS, your sales figures are saved on the bank server in a file, comparable to bank statements. This file is imported in your plentymarkets system and the sales figures are booked in plentymarkets. The linked EBICS account can be seen as a combined account of several bank accounts. A file with the sales figures of an EBICS account is generated daily (Format CAMT053 or MT940) after activation by the bank. This file can be retrieved at night and all incoming payments are available the next morning. In addition, multiple interim transaction report files are generated daily (Format CAMT052 or MT942) which can be retrieved to book interim transaction reports in your plentymarkets system.

Booking the EBICS module

To set up an account, the EBICS module first has to be booked in the configurator.

1. Applying for EBICS at your bank

The first step in using EBICS in plentymarkets is registering for the procedure with your bank to receive the necessary documents to fill out and return. Once completed, you will receive all data you need to use EBICS, e.g., the bank customer ID.
The following details for EBICS have to be entered in the form.

Existing EBICS accounts

It is not allowed to set up existing EBICS accounts which are already in use in plentymarkets. Multiple users (participants) can be listed in an EBICS account. If you already hold an account, then apply for a new one (technical user is also possible). Only use this account for plentymarkets.

1.1. Account numbers

Enter the account numbers for the accounts that you would like revenue to be retrieved and booked into plentymarkets from. Entering account numbers is optional because the retrieval is technically based on the user data.

Only save business accounts

There is currently no option in plentymarkets for setting up accounts individually for EBICS retrieval. This means that payment transactions can only be retrieved globally by the plentymarkets system for all accounts saved. This includes e.g. payment transactions on your private account as well, if this account was saved. For this reason, only save the account numbers of your business accounts.

One account for several users

If several different users all refer to the same account (some banks manage multiple accounts together), then problems may occur if retrieval is carried out simultaneously. This is true even if the users work with different plentymarkets systems. There is currently no solution to prevent this.

1.2. Provision of bank statements

Provisioning of bank statements can either be done based on the date of the bookkeeping entry or based on bank statements.

Table 1. Provision of bank statements
Setting Explanation

Based on date of bookkeeping entry

A fictitious, consecutive number is included. This setting is activated by default.

Based on bank statements

An effective bank statement number is included. Provided that automatic bank statement retrieval is carried out on a daily basis.

1.3. Participants

When setting up your accounts for EBICS, you create one or more users for your accounts. EBICS users are called participants (German: Teilnehmer). You can create participants including different order types. One of these participants has to be saved in the plentymarkets system with the participant ID that you received from your bank.

plentymarkets only requires one participant, e.g. a user account with the lowest rights, in order to carry out the EBICS payment retrieval. Only one participant may be set up per EBICS account.

1.4. Order type

Plentymarkets needs the order types as explained in Table 2 in order to successfully retrieve the transactions on your EBICS account. Also pay attention to the notes about order and signature types given on your bank’s forms.

Table 2. Order and signature types
Type Explanation

STA

Statement of account MT940 or CAMT053. Retrieval of the transactions at the end of the day.

VMK

Interim transaction report MT942 or CAMT052. Depending on the respective bank, interim transaction reports are created and made ready for retrieval several times a day. This information is optional for plentymarkets.

EU Type "T"

Signature type that provides authorisation exclusively for the retrieval of transaction data.

2. Creating an EBICS account

To use EBICS, you have to create an account first. To do so, proceed as described below.

Creating an account:

  1. Go to Setup » Orders » Payment » Plugin » EBICS.

  2. Click on Create new account ().
    → The Create new account window opens.

  3. Carry out the settings according to Table 3.

  4. Save () the settings.
    → The account is created.

Table 3. EBICS account settings
Setting Explanation

Active

Toggle to mark the account as active.

Account name

Enter the internal name under which the account appears in the overview.

First name

Enter the account holder’s first name.

Last name

Enter the account holder’s last name.

Bank subscriber ID

Enter the bank subscriber ID as submitted by the bank.

Bank customer ID

Enter the bank customer ID as submitted by the bank.

Bank

Select a bank from the list.

Create new bank

Activate to add a bank not listed in the list.
Bank: Enter the name of the bank.
URL: Enter the host URL as submitted by the bank.
This option is only available when creating a new account.

Account version

Select from the drop-down list which account version is be used. Details are available at the bank.

EBICS version

Select from the drop-down list which EBICS version your bank is using. Details are available at the bank.

Interim transaction report

Select from the drop-down list with which method the interim transaction reports are accessed. Details are available at the bank.

Daily account statements

Select from the drop-down list with which method the daily account statements are accessed. Details are available at the bank.

IBAN / Account number

Enter IBANs resp. account numbers of linked accounts separated by commas. The CAMT method requires the IBAN, the MT method requires the account number.

2.1. Carrying out EBICS account settings

After creating the account, you can change the settings by accessing it from the account overview. With a set up account, several functions are available to you. These are described in the following. In addition, the log next to the account lists the events for the specific account.

Editing the account

  1. Go to Setup » Orders » Payment » Plugin » EBICS.

  2. Click on Edit to open the account.
    → The window Account settings is opened.

  3. Carry out the settings. Pay attention to the explanations given in Table 4.

  4. Save () the settings.

Domain transfer

Save the basic settings again after carrying out a domain transfer. This updates the EBICS data.

Table 4. EBICS settings
Setting Explanation

Account settings

The settings for the selected account.

Transactions

Manages the business transactions to be retrieved.

Manual payment retrieval

Retrieves all orders of a certain date in case of a technical error.
Note: This function only retrieves the data already saved in the system; the bank is not contacted again.

Get status

Retrieves the current initialisation status from the EBICS tool.

Get order types

Retrieves the order types available on the account. These are the order types currently available on the server. Attention: Using this function too often can cause errors.

Initialise account

The keys are generated and sent to the bank via INI. HIA is activated.

Initialisation letter

Creates a PDF initialisation letter from the generated keys and downloads the document. It has to be signed and sent to the bank for initialisation. The button is inactive until the keys are successfully created.
Note: For the download of the initialisation letter to work properly, the pop-up blocker of your browser has to be deactivated.

Finish initialisation (HPB)

Completes the initialisation with the bank.

Expert Mode

All the following buttons are exclusively intended for the case that the bank required a new execution. The buttons are only available after the activation of the toggle.
Important: Using the expert mode can damage your account in a way it has to be reset by the bank. Use these functions only if demanded by your bank.

Create keys

Creates keys for initialisation.

INI

Initialises the EBICS account.

HIA

Activates HIA.

HPB

Activates HPB.

Contact your bank before making changes

Carry out changes only after consultation with your bank. For example, if you want to use the new CAMT formats, then ask your bank whether or not this format is supported and have the format activated. Then make any necessary changes to the account settings and interim transaction report as described here.

If an account was reset and your bank needs new keys, then we recommend that you set up the EBICS account again in plentymarkets. This way new keys will be generated.

2.2. Initialising the account

After you have entered your access data into plentymarkets, the system electronically registers at your bank. Secret key values are necessary for retrieval via EBICS. They are generated by the system. After these key values were created and the initial electronic registration was carried out, the values have to be printed out, signed and handed in at your bank. Only the participant saved in plentymarkets is authorised to sign this document. The bank will not activate the EBICS interface if the signature was not given by the participant saved in the system.

Browser pop-up blocker

For the download of the initialisation letter to work properly, the pop-up blocker of your browser has to be deactivated.

Initialising the account:

  1. Go to Setup » Orders » Payment » Plugin » EBICS.

  2. Click on the card of the account you want to initialise on Edit.
    → The window Account settings is opened.

  3. Click on Initialise account.
    → The keys are generated, INI and HIA are executed.
    Once all processes are completed successfully, the button Create initialisation letter is activated.

  4. Click on Create initialisation letter.
    → The initialisation letter is downloaded as a pdf document.

  5. Sign the initialisation letter and submit it to your bank.
    → The bank checks the information and approves the account. You are informed once this process is complete.

  6. Click on Finish initialisation (HPB).
    → The account is successfully initialised.

The electronically submitted values will be compared with the values on the printed document. Then, the EBICS interface will be activated. From this moment on, the transactions will be retrieved at the retrieval times listed below.

3. Retrieval times of transactions

Maximum twice a day, your bank provides the day’s transactions in a data format. Currently, plentymarkets retrieves this data at 6am, 1pm and 11pm. Transaction data is available in the system approximately one hour after the retrieval. In addition, the bank provides interim transaction reports in data format several times a day. These can be retrieved and include the transactions of the current day.

4. Retrieval times of interim transaction reports

Since the times when interim transaction reports are made available differ from bank to bank, plentymarkets retrieves them from the banks, if they are available, every hour between 8am and 6pm. For EBICS postings that have unconfirmed interim transactions, the words interim transaction will be displayed in red. If the interim transaction has been confirmed, then the lettering will change from red to green. Additionally, the confirmed posting will be assigned to the corresponding order without having to book the payment again. You have to activate the statement of account in order for interim transaction reports to be confirmed. Pay attention to the explanations given in Table 1.

5. Managing transactions

Business transactions are all order types you conduct with your credit institute. The plugin installation does not imbed any transactions. To automatically import and assign the most common transactions, activate the following standard business transactions:

  • 005 – Direct Debit

  • 006 – Other debit entry advice

  • 020 - Transfer order

  • 051 - Transfer credit note

  • 052 – Recurring entry credit memo

  • 063 – Remittance credit – EU standard remittance

  • 065 – Remittance credit (cross-border remittance without reporting data)

  • 070 – Cheque presentation

  • 088 – Remittance credit with fixed value date

  • 104 - SEPA Direct Debit (single entry – debit, B2B)

  • 105 - SEPA Direct Debit (single entry – debit, Core)105 - SEPA Direct Debit (single entry – debit, B2B)

  • 106 – SEPA Cards Clearing (single entry - debit)

  • 107 – SEPA Direct Debit (single entry - debit, direct debit generated by debit card at the point of sale)

  • 152 – SEPA Credit Transfer (credit, recurring instalment payment)

  • 159 – SEPA Credit Transfer return (credit) for remittance that cannot be credited (reverse remittance)

  • 166 - SEPA Credit Transfer (single entry – credit)

  • 169 – SEPA Credit Transfer (single entry – credit, charity payment)

  • 181 – SEPA Direct Debit (credit; recredit, Core)

  • 184 – SEPA Direct Debit (credit; recredit, B2B)

  • 201 – Payment order

  • 202 – Cross-border payment

  • 206 – Cross-border remittance

  • 211 – Receipt of electronic payment

Managing transactions:

  1. Go to Setup » Orders » Payment » Plugin » EBICS.

  2. Click on the card of the account you want to manage on Edit.
    → The window Account settings is opened.

  3. Click on Transactions.

  4. Carry out the settings according to Table 5.

  5. Save () the settings.

Table 5. Managing settings for business transactions
Setting Explanation

Code

Enter the code of a specific transaction and click Search.

Description

Enter the description of a specific transaction and click Search.

Display

As a standard, only active transactions are displayed.
All: Displays a list of all transactions.
Active only: Displays all active transactions.
Inactive only: Displays all inactive transactions.

Group

All: Displays a list of all transactions.
Credit: Displays all transactions of type Credit.
Debit: Displays all transactions of type Debit.

Loading inactive transactions

If you receive payments with a transaction you have not activated, the EBICS plugin cannot process them. Add these transactions to your account.

Loading inactive transactions:

  1. Go to Setup » Orders » Payment » Plugin » EBICS.

  2. Click on the card of the account you want to initialise on Edit.
    → The window Account settings is opened.

  3. Click on Transactions.

  4. Click on Load inactive transactions.
    →The search window is opened.

  5. Enter the date for which you want to load the transactions.

  6. Click on Search.
    → All payments for the selected date which do not fall under the activated transactions are displayed.

  7. Select the transactions you want to activate.

  8. Save () the settings.
    → The transactions are activated.

To assign the payments, execute the Manual payment retrieval as described above. All future payments are automatically assigned.

5.1. Adding new transactions

If you receive payments with a transaction code that has not yet been activated, it will automatically be added to the global list. From there, they can be activated as described above.

6. Migrating the old integration

If you are using the current EBICS integration, you can migrate your existing accounts to the new plugin. To do so, proceed as follows. The migration button is displayed only if the old integration has accounts that are active and correctly initialised by the bank.

Migrating data:

  1. Go to Setup » Orders » Payment » Plugin » EBICS.

  2. Click on Migration of existing EBICS accounts.
    → All data of the existing integration are migrated to the plugin.
    → The button is deactivated.
    → All accounts are activated in the plugin.

  3. Deactivate the accounts in the old integration.

  4. Activate the transactions in the accounts in the plugin as described above.

7. FAQ about the EBICS plugin

In this section, FAQ about configuring the EBICS plugin are compiled.

For general information about the development of the plugin, you can also read this German Blog entry .

7.1. How do I use the EBICS plugin?

To use the EBICS plugin, you first have download it from the plentyMarketplace . To set up EBICS you have to carry out a few basic settings in your plentymarkets system. These are explained at the top of this manual page.

You can find more information on adding and installing plugins in the Plugins section of the manual.

7.2. How do I open a new account?

First, a new account is created with the data from the bank’s letter. When you select a bank, verify that the URL as well as the host parameter are identical with the ones on the bank letter.

Keys are generated and the INI- as well as the HIA-Call are performed via the initialise account button on the Setup » Orders » Payment » Plugins » EBICS menu. After this, the INI-letter can be issued. This takes place in your browser via a direct pdf download. Make sure that pop-ups are not deactivated while doing this.
The INI-letter has to be signed and send to the bank as fast as possible. he initialisation is discarded after 2 weeks if the INI-letter has failed to arrive. The bank activates the account when everything is set up correctly. Only click on the button conclude account-initialisation (HPB) in the account settings after clearance from the bank. After this, the account is successfully initialised.Find more information about initialisation in the section Initialising the account.

In order to have the payments imported, make sure that the business transactions are activated for the payment retrieval in the Setup » Orders » Payment » Plugins » EBICS menu. Find more information about transactions in the section Managing transactions.

The button initialise account should only be clicked once. If you click several times, problems and consequential errors can occur. You can track the individual steps in the log.

7.3. Payments are not retrieved. What can I do?

Check the following:

  • Is the EBICS account set up completely? → Check this with the help of the explanations on the manual page.

  • Are the access data correct? If the error message EBICS_AUTHENTICATION_FAILED is displayed, authentication failed because access data are wrong.

  • Do you work with external programmes that also retrieve payments? In this case, the payments do not get imported int your plentymrkets system because payments are not retrieved several times.

  • Check whether the interim transaction report and the daily account statements are using the correct formatting. Formatting can be adjusted in the account settings. The bank is providing the transaction file in the format CAMT or MT.

  • Are all required transaction active? → Proceed as follows to activate transactions.

Activating transactions:

  1. Select the active account the the Setup » Orders » Payment » Plugin » EBICS menu.

  2. Select the menu entry business transactions in the account settings.

  3. Activate the inactive business transactions.

  4. After the first payment retrieval: load inactive business transactions.

  5. Choose the inactive business transaction via the drop-down list Show and activate as required.

ebics transactions en
Figure 1. Activating transactions

7.4. The bank provides the transaction file at X o’clock. Why does plentymarkets retrieve the file later?

The retrieval takes place once a day via a cron. The cron inquires hourly whether there is a transaction file. The payment retrieval mostly takes place in the evening or at night. This is connected to the provision of the transaction files by the bank.
The daily account statement can also be provided several times a day. The transaction file for the daily account statement and the interim transaction report are provided at different times.

7.5. What do the fields daily account statement and interim transaction report mean?

  • Daily account statement = Confirmed booking which is mostly only provided once a day.

  • Interim transaction report = Authorised booking which is provided several times a day and reserves the incoming payments.

The interim transaction report is overridden by the confirmed booking.

The daily account statement and the interim transaction report should always have the same formatting. Otherwise, errors in the allocation of payments might occur.

7.6. What is the difference between CAMT and MT?

CAMT and MT are data transaction formats that are used in the transaction files. Only one format is used in the transaction file itself.

Table 6. The formats CAMT and MT in comparison
CAMT MT

Description

Cash management

Message type

IBAN field in account settings

IBAN

Account number

Transaction files

Uniform format of SEPA, supersedes the SWIFT-format

SWIFT standard format

You can get more information about these formats in the following German forum’s entry .

To top