Monetico - User Guide

Documentation index

You can download this Monetico Documentation as a PDF file.

Monetico CM-CIC is a payment gateway extension and provides CM-CIC payment (new version of CyberMUT/CIC payment) integration. This extension allows you to install and configure easily your electronic payment terminals for Magento 2.x.

1. Information

Monetico CM-CIC has been developed to help you to install and configure your electronic payment system. Before installing and use this extension, you should have an opened electronic payment terminals account from one of these following banks: Crédit Mutuel, CIC.
The allowed payment card are the CB/Visa, EuroCard/MasterCard. American Express and PayPal are available too, but you should sign a contract with them.

2. Installation

First of all, download the package of the module and unzip it at the root of your Magento 2 instance.

Then run the following command in your cli, at the root of your magento:
Php bin/magento setup:upgrade

3. How it works

Monetico is a gateway payment solution. Blackbird has developed a module to integrate this solution into Magento 2.x.
After placing the order, the customer is redirected to the Monetico server. The customer fill the payment form and a response is sended to your Magento. According the code response, and your configuration, the order is processed.
For further information and see the full process, visit this link:

4. How to configure

Before installing Monetico for Magento 2.x, sign up for a Monetico account. You can create an account at this link:

Available Payment Methods

The following payment methods are available with this Monetico extension. You can enable them all or just the one you need.

    • One-time payment
    • The usual one-time payment with CM-CIC electronic payment terminal. The purchases are fully paid in one time.
    • Multi-time payment
    • The customer is able to pay in 2,3 or 4 times. The purchases are paid in several times, the merchant take the risks.
    • Cofidis 3 x CB & 4 x CB Payment
    • The purchases are paid in 3 or 4 times by the customer, but the merchant take 0 risk and he’s paid in one time.
    • Paypal Payment
    • The customer pay through the PayPal platform.

API Monetico Settings

The following fields allows you to connect your Magento to your Monetico account. You can’t enable the payment method if this part is not correctly fulfilled. These information are available in your Monetico account:

Version 3.0 : version of the Monetico payment system.
Environment Sandbox : this mode is used for test payment action.
Production : this mode is only for production purpose.
TPE Number Number of the merchant virtual TPE. It’s a string of 7 chars.
Site Code dentifier of the website you use this extension for.
Security Hash Key This key is used to encrypt the data sent to Monetico via the sealed form.

Common Setting

These data are common for all payment methods through Monetico.

Empty the cart after Cancellation The cancellation of the payment will empty the cart.
Redirect to checkout after Cancellation Yes : the customer is redirected to the checkout cart.
No : the customer will be redirected on the default failure page.
Cancellation message Here you can replace the default message of the failure page. The message by default is the following: “Your order has been canceled.”
Enable automatic cancellation Yes : the order will be cancelled if the person was not paying before X days. You set the number of days in the next field.
No : the order will remain in the pending status until further customer/merchant action.
Enable Debug Mode Yes : we trace the events in the /var/log/monetico.log file

Order Status Settings

You can define the state of your order, step by step, during the all payment process.

New order status Pending
Suspected Fraud
Payment Validated Order Status Processing
Suspected Fraud
Payment Refused Order Status Canceled
On Hold
Payment Canceled order Status Canceled
On Hold
Create Invoice Yes

Country Specific Settings

Similar to the other payment solution, you can Disable/Enable a payment method depending on the billing address country.

3D Secure Verification Settings

The 3DSecure is always enabled, but some merchants may need to disable it for small amounts. The module allows you to select the amount for which the 3D Secure is enabled.

Activate the 3D Secure Yes: 3D secure is activated for all the payments.
No : 3D secure is not activated under a certain amount. Then choose the minimum amount to enable the 3D Secure
Ex : 300€. 3D Secure will be implemented for every orders worth 300€ or more.

Monetico Interface Settings

Include the Monetico payment page in Iframe Yes: the customer is not redirected to the Monetico payment gateway and can directly pay through Monetico on your website.
No the customer is redirected to the Monetico payment gateway.
Locale configuration
(for the Monetico payment page)

Transaction description

You can customize the transaction description, these variables can be used:
%order_id% : Order ID number
%payment_method% : Payment Method name
%code_societe% : Store Code Name
We will use the current store language in preference.
Transaction Message If empty, a default message is printed.

Option settings

You enable or disable the Monetico options in your contract and configure them.

Enable the Payment Express Option Yes: if you have this option in your Monetico contract, then the user can save his payment information and have a pre-filled form.
Enable all Payment Options Yes: enable all the payments options.
No select the specific payment options you don’t want in the next field.
Disable Specific Payment Options
(only for the one-time payment method)
Select the payment options you don’t want as a payment option.

Specific options to multi-time payments

Several payment configuration

We will split equally the payment in many capture amount if the values are empty. The total terms rate should be equal to 100%.

Number of payment terms 2, 3 or 4Payments will be done in several monthly captures.
Enable all Payment Options Yes: enable all the payments options.
1st due-date (%)
2nd due-date (%)
3rd due-date (%)
4th due-date (%)
We will capture the part of the total amount corresponding to the different terms.

Cofidis 3 x CB and 4 x CB Payment

The purchases are paid in 3, 5, 10, 20 times or small amounts by the customer, but the merchant is paid in one time.

Enable this solution Yes will make it available on the front office.
Minimum Amount Set the minimum order amount to make this payment solution available.
Maximum Amount Set the maximum order amount to make this payment solution available.
Title The title of the payment method displayed in the front office.
Sort order The order of appearance in the list of available payment methods.

5. How to use

As seen previously, you can modify your environment status by modifying the value of the ‘environment’ field. In order to use the Monetico solution, you should enable the extension and enable the solution in the payment methods configuration (Stores > Settings - Configuration > Sales > Payment Methods > Monetico).

Test Environment

You can set your payment environment in test by setting the ‘environment’ field to ‘Sandbox’. Check if you have a TPE ready for the tests (you can do that in your Monetico account dashboard). All the payment proceed on your Magento are redirected to the testing TPE.
For further information for how to set and configure the test environment in your Monetico account, visit the official Monetico documentation:

Production Environment

You can set your payment environment in production by setting the ‘environment’ field to ‘Production’. Before editing this field, check all your basic Monetico settings (Version - TPE number - Site Code - Hash Key). In order to complete the configuration, the merchant must send, from the email he given to Monetico, the ‘url back’ to the Monetico support (

Instant Payment Notification URL

In order to process your command according to the payment status, you should have correctly configured your IPN. Please complete and sent the following url to the Monetico support, at:

The IPN url is: /monetico/payment/notify
Note that the IPN url only allows POST requests.

Download this documentation as a PDF file.

Find out about the license.

For further information, feel free to contact us