Setting up the connection to the bank account (EBICS)
The API can be used to establish a connection to your own bank account so that each QR invoice can be automatically checked to see whether payments have been received. The status of the invoices and the associated WooCommerce orders can therefore be automatically updated.
In order for transactions to be pulled from your bank account to update QR-Bills in WooCommerce, the following requirements must be met:
- QR-IBAN available for the bank account and entered under “QR-Bill > Settings”. If no QR-IBAN is available, it can be requested from the bank.
- EBICS access for the bank account (see below).
- Valid QR-Bill for WooCommerce plugin license.
1. Request EBICS access
Please contact your bank to receive the parameters to set up the EBICS access for your bank account. The EBICS access is only needed to retrieve incoming payments in camt.054 format (i.e. no payments need to be made). You will also need a QR-IBAN for your bank account to create QR references for the QR-bills.
2. Activating the service
After receiving the parameters from your bank you can log into your account at mamedev.app. You can find the username and password for mamedev.app in your account at mamedev.ch. Alternatively you can fill in the registration form at mamedev.app/register.
Go to the page “Applications > QR-Bill > EBICS integration > Settings” to start the setup.
2.1 Payment method
In the first step you need to add a payment method to activate the service. The service can be stopped anytime.
2.2 Add store
In the next step you can add a new store. Enter any name for the store to make it easier to identify.
The IBAN, not the QR-IBAN, must be entered in the “Bank account IBAN” field.
The Notification URL is the URL for the JSON REST API of the WordPress site. Usually this is made up of the page URL and the ending “/wp-json”.
3. EBICS setup
After activating the service and adding a store you can start the EBICS setup on the page “Applications > QR-Bill > EBICS integration > Settings > Add EBICS connection”.
3.1 EBICS parameters
Choose any name for the connection to make it easier to identify. Select your Bank and enter the IBAN (not the QR-IBAN). Please contact us if your Bank does not appear in the dropdown.
Enter the parameters you received from your bank into the fields “EBICS Partner ID / Customer ID” and “EBICS User ID / Participant ID” and click “Initialization”.
3.2 Send bank letter
In the next step, download the bank letter, sign it on every page and send it to the bank. Then, click “Bank letter sent”.
3.3 Retrieve bank keys
The bank will contact you regarding the status of your EBICS connection (normally within the next few days). After the connection is set up by the bank, you can then click “Retrieve bank keys” to complete the setup.
3.4 Assign connection to store
You can now edit the store and add assign the EBICS connection.
4. API credentials
After setting up the EBICS connection, you need to connect the plugin to your account at mamedev.app.
Go to the page “Settings (cogwheel in the top right) > API settings”. On this page you can generate a new webhook key by clicking on the “Generate new key” button.
On the same page under “Api Tokens > Add Api Token” you can generate a new token. Enter any name (e.g. the name of your shop) and select “QR-Bill” in the selection field. Please save the token as it will only be displayed once and cannot be retrieved afterwards.
5. Settings in the WordPress backend
Log into the WordPress backend of your website and go to the page “QR-bill > Settings”. On this page, enter the API token and the Webhook key from step 4 and then save the settings.
Next, click “Synchronize” under “EBICS > Store ID” to load the store you added in your account at mamedev.app. Select the store and save the settings to complete the setup.
