Ifthenpay Prestashop 8 payment module

Read this in Portuguese, and English

1. Introduction

2. Compatibility

3. Installation

4. Configuration

Backoffice Key
Enable Payment Method
Multibanco
Multibanco with Dynamic References
MB WAY
Credit Card
Payshop
Cofidis Pay

5. Edit payment details

Update Payment Data
Resend Payment Data
Remember Payment Data
Choose Payment Method

6. Other

Support
Request account
Request additional account
Logs
Reset Configuration
Updates
Sandbox Mode
Callback
Test Callback

7. Customer usage experience

Paying order with Multibanco
Paying order with Payshop
Paying order with MB WAY
Paying order with Credit Card
Paying order with Cofidis Pay

Introduction

This is the Ifthenpay plugin for Prestashop e-commerce platform

Multibanco is one Portuguese payment method that allows the customer to pay by bank reference. This module will allow you to generate a payment Reference that the customer can then use to pay for his order on the ATM or Home Banking service. This plugin uses one of the several gateways/services available in Portugal, IfthenPay.

MB WAY is the first inter-bank solution that enables purchases and immediate transfers via smartphones and tablets.

This module will allow you to generate a request payment to the customer mobile phone, and he can authorize the payment for his order on the MB WAY App service. This module uses one of the several gateways/services available in Portugal, IfthenPay.

Payshop is one Portuguese payment method that allows the customer to pay by payshop reference. This module will allow you to generate a payment Reference that the customer can then use to pay for his order on the Payshop agent or CTT. This module uses one of the several gateways/services available in Portugal, IfthenPay.

Credit Card This module will allow you to generate a payment by Visa or Master card, that the customer can then use to pay for his order. This module uses one of the several gateways/services available in Portugal, IfthenPay.

Cofidis Pay is a payment solution of up to 12 interest-free installments that makes it easier to pay for purchases by splitting them. This module uses one of the several gateways/services available in Portugal, IfthenPay.

Contract with Ifthenpay is required.

See more at Ifthenpay.

Compatibility

Follow the table below to verify Ifthenpay's module compatibility with your online store.

	Prestashop 1.6	Prestashop 1.7	Prestashop 8 [8.0.0 - 8.1.1]
Ifthenpay v8.0.0 -> v8.1.1	Not compatible	Not compatible	Compatible

Installation

You may install the module for the first time on you Prestashop platform or just update it.

To install it for the first time, go the module's Github page and click the the latest release;

And download the installer zip named "ifthenpay.zip";

Or if you are upgrading, you can download it from Prestashop in Modules/Ifthenpay/Configure;

Go to Module Manager;

Click "Upload a module";

Drag the installer zip on to "Upload a module" box;

Configuration

Backoffice key

After a successful installation click the "Configure" button;

Insert your Ifthenpay Backoffice key and save:

The backoffice key is given upon contract and is made of four sets of four digits separated by a dash (-), insert it in the Backoffice key field;
Click "Save" button;

Enable Payment Method

The following takes Multibanco as example, but the process is the same for the remaining payment methods

To enable a payment method, follow the steps:

(optional) Switch on this option if you are testing the payment methods, this will prevent the callback activation;
Enable the payment method by switching the "Status" to Enabled;
Click "Save" button;

Multibanco

To configure Multibanco payment method click the "MANAGE" button for Multibanco;

Configure Multibanco payment method:

Activate Callback, by selecting this option the order state will update when a payment is received;
Select an Entity. Can only select from the Entities associated with your Backoffice Key;
Select a Sub Entity. Can only select from the Sub Entities associated with Entity previously selected;
(optional) Input minimum order value to only display this payment method for orders above it;
(optional) Input maximum order value to only display this payment method for orders below it;
(optional) Select one or more countries to only display this payment method for orders with that shipping country, leave empty to allow all;
(optional) Input an Integer number to order this payment method in the checkout page. Smallest takes first place;
Click "Save" button;

If you previously set the "Callback" to activate, after saving, it's state will be updated below with the generated Anti-Phishing key and Callback Url;

Multibanco with Dynamic References

Multibanco with Dynamic References payment method generates references by request, and is used if you wish to add a deadline with limited number of days to your order payment.

Configure Multibanco with Dynamic References:

Select "MB" from the Entity field, this entity will only be available for selection if you contracted an account for Multibanco with Dynamic References;
Select a Sub Entity.
(optional) Select number of days for deadline.
(optional) Activate Cancel Multibanco Order, by selecting this option, Multibanco orders that are still unpaid after the deadline will have status changed to "Canceled";

MB WAY

Click the "Manage" button for MB WAY;

Configure MB WAY payment method:

Activate Callback, by selecting this option the order state will update when a payment is received;
(optional) Activate Cancel MB WAY Order, by selecting this option, MB WAY orders that are still unpaid 30 min after confirmation, will have status changed to "Canceled";
MB WAY Countdown, set to "Activate" by default, this option determines whether the MB WAY 5 minutes countdown is displayed or not after confirming order;
Select a MB WAY key. Can only select from the MB WAY keys associated with your Backoffice key;
(optional) Input minimum order value to only display this payment method for orders above it;
(optional) Input maximum order value to only display this payment method for orders below it;
(optional) Select one or more countries to only display this payment method for orders with that shipping country, leave empty to allow all;
(optional) Input an Integer number to order this payment method in the checkout page. Smallest takes first place.
Click "Save" button;

If you set the "Callback" to activate, it's state will be updated below with the generated Anti-Phishing key and Callback Url;

Credit Card

In Modules/Ifthenpay/Configure, click the "MANAGE" button for Credit Card;

Configure Credit Card (also referred to as Ccard) payment method:

Select a CCard key. Can only select from the CCard keys associated with your Backoffice key;
(optional) Activate Cancel Credit Card Order, by selecting this option, Credit Card orders that are still unpaid 30 min after confirmation, will have status changed to "Canceled";
(optional) Input minimum order value to only display this payment method for orders above it;
(optional) Input maximum order value to only display this payment method for orders below it;
(optional) Select one or more countries to only display this payment method for orders with that shipping country, leave empty to allow all;
(optional) Input an Integer number to order this payment method in the checkout page. Smallest takes first place.
Click "Save" button;

Payshop

In Modules/Ifthenpay/Configure, click the "MANAGE" button for Payshop;

Configure Payshop payment method:

Activate Callback, by selecting this option the order state will update when a payment is received;
Select a Payshop key. Can only select from the Payshop keys associated with your Backoffice key;
(optional) Input a Deadline for payment, from 1 to 99 days or leave empty if you do not want it to expire;
(optional) Activate Cancel Payshop Order, by selecting this option, Payshop orders that are still unpaid after the deadline will have status changed to "Canceled";
(optional) Input minimum order value to only display this payment method for order above it;
(optional) Input maximum order value to only display this payment method for order below it;
(optional) Select one or more countries to only display this payment method for orders with that shipping country, leave empty to allow all;
(optional) Input an Integer number to order this payment method in the checkout page. Smallest takes first place.
Click "Save" button;

If you set the "Callback" to activate, it's state will be updated below with the generated Anti-Phishing key and Callback Url;

Cofidis Pay

In Modules/Ifthenpay/Configure, click the "MANAGE" button for Cofidis Pay;

Configure Cofidis Pay payment method:

Activate Callback, by selecting this option the order state will update when a payment is received;
Select a Cofidis Pay key. Can only select from the Cofidis Pay keys associated with your Backoffice key;
(optional) Activate Cancel Cofidis Pay Order, by selecting this option, Cofidis Pay orders that are expired 60 minutes after confirmation will have status changed to "Canceled";
(optional) Input minimum order value to only display this payment method for order above it. Important Notice: On Cofidis Key selection, this input is updated with value configured in ifthenpay's backoffice, and when editing, it can not be less then the value specified in ifthenpay's backoffice.;
(optional) Input maximum order value to only display this payment method for order below it. Important Notice: On Cofidis Key selection, this input is updated with value configured in ifthenpay's backoffice, and when editing, it can not be greater then the value specified in ifthenpay's backoffice.;
(optional) Select one or more countries to only display this payment method for orders with that shipping country, leave empty to allow all;
(optional) Input an Integer number to order this payment method in the checkout page. Smallest takes first place.
Click "Save" button;

If you set the "Callback" to activate, it's state will be updated below with the generated Anti-Phishing key and Callback Url;

Edit payment details

Important Notice: It is not possible to change to or update to the Credit Card and Cofidis Pay payment methods. At Prestashop order details, you can edit the order payment method and payment data. An use case for this would be a customer ordered 2 units of a product, but decided to only get one, so the customer contacts the store admin and requests that change. The store admin edits the product quantity and at the bottom of the page clicks the "Update Multibanco/MB WAY/Payshop Data" button and next clicks the "Resend Payment Data". Multibanco payment method is used to explain the following procedures. The procedures are the same for all methods apart from MB WAY that does require a phone number.

Update Payment Data

After changing the order, click the "Update Multibanco Data" button;

Resend Payment Data

After updating the payment data, you must resend the payment details to this order's customer by clicking the "Resend Payment Data" button;

Remember Payment Data

If you have long deadlines on your payment methods and want to remind your customer of an order's pending payment, click the "Remember Payment Details" button;

Choose Payment Method

Choose a different payment method:

Start the process by clicking the "Choose new Payment Method" button;

From the newly shown select box, select your new payment method (1), and click the "Change Payment Method" button (2);

The payment details will be updated with the new methods payment data, now you must click the "Resend Payment Data" to let your customer know;

If you are changing from Multibanco or Payshop to MB WAY, you are required to input the customer's phone number and click the "Change Payment Method" button. This action sends the MB WAY notification automatically, but you can use the "Resend Payment Data" button if the customer does not pay in the 5 minutes time window and requires another payment notification to their MB WAY app;

Other

Support

In Modules/Ifthenpay/Configure click the "Go to Support!" button to be redirected to the Ifthenpay helpdesk page;

Request account

If you still do not have an Ifthenpay account, you may request one by filling the membership contract pdf file that you can download by clicking the "Request an account!" button, and send it along with requested documentation to the email ifthenpay@ifthenpay.com

Request additional account

If you already have an Ifthenpay account, but don't have a payment method unlocked, you can make an automatic request to Ifthenpay;

At Modules/Ifthenpay/Configure, there will be a "REQUEST ... ACCOUNT CREATION" button for every payment method that you have yet to unlock. Click the button for the payment method you require. After Ifthenpay's team have added your payment method, the list of payment methods available on your module will be updated with the new one.

Logs

You can consult logs related to this module at Module/Ifthenpay/Configure by clicking the tab "LOGS";

The logs will record errors and other events that can be helpful in detecting issues;

Reset Configuration

If for example you acquired a new Backoffice key, and want to assign it to your site, but already have one assigned, you can reset the module's configuration. At Module/Ifthenpay/Configure click the "Reset" button. Warning, this action will reset all current configurations for this module;

After reset, you will once again be asked for your Backoffice key;

Updates

At Module/Ifthenpay/Configure, bottom of the page you can check if there are any updates available for the module;

Sandbox Mode

You may want to run tests before going into production. To do so, you must turn "Sandbox Mode" to Enabled and click the "Save" button, before activating any payment method Callback. The Sandbox Mode is used in order to prevent the Callback activation and the communication between our server and your store.

Callback

Callback is a functionality that when active, will allow your store to receive the notification of a successful payment. When active, a successful payment for an order will trigger a change in that specific order's status to "paid" or "processing" (status name will depend on your Prestashop configuration). You can use the Ifthenpay Payment methods without activating the Callback, but your orders will not update their status automatically;
Callback statuses:

Callback Disabled (order will not change state upon receiving payment);

Callback Activated (order will change state upon receiving payment);

Callback Activated & Sandbox Mode enabled (order will not change state upon receiving payment);

Test Callback

In each payment method config page (except Ccard), you can test the Callback functionality by clicking the "Test Callback" button. This will simulate a successful payment for a order in your store, and will change its status. Requires Callback to be activated;

Multibanco: Use the following data (1) and (2) from order payment details:

to fill the Test Callback form and click the "Test Callback" button (3):

MB WAY: Use the following data (1) and (2) from order payment details:

to fill the Test Callback form and click the "Test Callback" button (3):

Payshop: Use the following data (1) and (2) from order payment details:

to fill the Test Callback form and click the "Test Callback" button (3):

Cofidis: Use the following data (1) and (2) from order payment details:

to fill the Test Callback form and click the "Test Callback" button (3):

Customer usage experience

The following action are described from the perspective of the consumer.

Paying order with Multibanco

Select Multibanco at checkout and place order:

Select "Pay by Multibanco";
Check the box of "terms of service" (this will depend on your Prestashop configuration);
Click "PLACE ORDER" button;

Upon confirmation, you will be greeted with the Multibanco payment information;

Paying order with Payshop

Select Payshop at checkout and place order:

Select "Pay by Payshop";
Check the box of "terms of service" (this will depend on your Prestashop configuration);
Click "PLACE ORDER" button;

Upon confirmation, you will be greeted with the Payshop payment information;

Paying order with MB WAY

Select MB WAY at checkout and place order:

Select "Pay by MB WAY";
Input the mobile phone number of a smartphone with MB WAY app installed;
Check the box of "terms of service" (this will depend on your Prestashop configuration);
Click "PLACE ORDER" button;

Upon confirmation, you will be greeted with the MB WAY countdown, and payment information:

MB WAY countdown;
MB WAY payment information;

During countdown, interactions from user with MB WAY app will update countdown accordingly:

if you accept the payment in the smartphone's MB WAY app, the countdown will update with "Order Paid!";

if you reject the payment in the smartphone's MB WAY app, the countdown will update with "payment refused!";

if at checkout you inputted a phone number to a smartphone that does not have MB WAY app installed, or there are communication issues with SIBS servers at that moment, the countdown will update with "payment failed!";