PrestaShop Payment Module

Last Updated: Sep 7, 2022

Module overview

The Truevo PrestaShop Payment Module makes accepting ecommerce payments easy. Your customers will not only be able to make payments on your website but will also have the ability to securely save their card details for convenient repeat purchases. In addition, you will be able to perform full reversals and full or partial refunds from the PrestaShop backend system. 

We’ve also included some important transactional information for you, meaning doing reconciliation between your PrestaShop backend and Truevo Portal just got easier.

Compatible with Prestashop 1.7 or higher.

Installation steps

Step 1

Download the module. Do not unzip or rename the file, doing this will cause the installation to fail.

Step 2

Let’s be careful. Sometimes complications can arise when you install third-party modules. We suggest that you make a backup of your shop. We also recommend first testing the integration on a test system, if you can.

Step 3

Log in to your PrestaShop Admin, navigate to Modules > Module Manager and click on Upload a module.

Step 4

Click Choose File and select the downloaded Truevo Payment Module zip, then select Install Now. Remember, it’s important that you do not unzip this file before you upload it. If you are struggling to find the plugin on your computer it is labelled: truevo-prestashop-payment-gateway-v1.4.1.

Step 5

Once the file has been uploaded it may give you the option to immediately activate the module, if not, navigate to Modules > Module Manager > scroll down till you find the Payment section, locate the Truevo Payment Gateway and select Configure. Check that the version installed is v1.4.1.

Configuration​

Step 1

Once you’ve found the Truevo Payment Module and selected Configure you need to select Enable Truevo Gateway.

Step 2

Next you will be asked to provide a Payment Method Title and Payment Method Description.

The Payment Method Title is what your customers will see when selecting a payment method. When choosing what to place here we suggest keeping it short, simple and clear, for example, use: Pay with a card.

The Payment Method Description provides your customers with more information about how they are paying. Here it’s a good idea to mention what types of cards they can use, for example: Pay with a Visa, Mastercard or Maestro debit or credit card.

Step 3

Add your Production Merchant ID (mid), Production Terminal ID (tid) and Production Authentication Token. These pieces of information would have been provided to you via email. What does each of these do?

The Merchant ID is a unique number that we’ve registered with the schemes and is what is used to identify your business. Each mid is also associated with a single currency.

The Terminal ID is linked to the mid and is used to identify the source of the transaction.

The Authentication Token is assigned to an account and makes it possible to perform transaction requests such as reversals and refunds. It also makes it possible for us to provide detailed transaction information to the WooCommerce backend, which makes reconciliation easier.

At this point, you can also enable test mode. Don’t worry, if you choose to enable test mode your Production mid, tid and Authorisation Token will save and you will not have to input them again. We recommend doing a few tests before going live. You can find testing credentials below.

Step 4

You will now see the option to Enable Pre-Authorisation. By enabling this each payment made on your store will be a pre-authorised payment, in order to complete the transaction you will need to capture the payment. You can use the PrestaShop backend to capture the full pre-authorised amount, however, if you would like to capture a partial pre-authorisation you will need to do this from the Truevo Portal.

Please note that this feature will only work if your account has been set up to accept pre-authorisations.

Step 5

Next you will be asked if you want to enable tokenisation. This feature allows your customers to securely save their card details, making repeat purchases easier and faster.

How does it work? If enabled, your customer will need to create a profile on your ecommerce store. When entering their card details for the first time they will need to select the checkbox that says: Save card details. When your customer returns to make another purchase they will be shown a list of card details they have previously provided and can select an existing card, or add a new one. If they select an existing card they will simply enter their security code and go through the 3D Secure v2 flow. This significantly speeds up the checkout process.

Step 6

When designing the Truevo payment form we went for a very minimalistic design, with the aim of making it look like it belongs on your website. If you would like to personalise your form you are welcome to do so by adding some custom CSS. Please note that this will only let you make adjustments to the colour, font and general styling, you will not be able to change the placement of the form or the payment flow. For more information on how to customise your form with CSS please review our styling capabilities documentation.

Step 7

The last configuration item is to enable logging. We encourage you to enable this as it will provide valuable information in the event that you are experiencing any issues with a payment.

Step 8

And last but not least, save. If you close this configuration page without saving, all of your settings will be deleted and you will need to redo the configuration.

Test integration credentials

Please note that test credentials will not work in a live environment and that any transactions done in the test environment will not show up in your Truevo Portal. The credentials you use will also need to be in the same currency as your online store, below we have provided test credentials for EUR, GBP and USD, however, the token will be the same for all three currencies.
EUR GBP USD
Test Merchant ID (mid)
00000521
00000562
00000564
Test Terminal ID (tid)
00009645
00009903
00009912
Test Token

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJVU0VSSUQiOiIyOTU1M0I2MC00RTYyLTRBOEMtQjdBMi1GNDkwMTZFODgyRTQiLCJpYXQiOjE2NDYzMTM5NTYsImV4cCI6MTk2MTg4OTk1Nn0.D19Ly4EqrHJpz7G6p2hivhlGcdcMHQcKwQw0yBpntzk

Test card details

Please note that test card details will only work with the test integration credentials and not with your live credentials. The test card details below will not include the 3DS flow, to test 3DS please use your live credentials and a real card.
Success Non-3DS
Card type
Mastercard Credit
Card number
5522000000000750
Expiry date
01/23
Cardholder name
Test
Security code
123

How to perform reversals and refunds

With our new Truevo Payment Module you are able to perform reversals and refunds from within the PrestaShop backend. To start out, we’re going to define the difference between a reversal and a refund. 

A reversal occurs when the funds from a transaction are returned to a customer before the payment has cleared. This means that the reversal request was performed the same day that the transaction took place (before 00:00 CET/CEST).  For this reason, reversals are also for the full transaction amount and it will be as if the transaction never occurred, i.e. there will be no record of the transaction in your customer’s bank account.

A refund occurs when the funds from a transaction are returned to a customer after the payment has cleared. Because the transaction has been completed and the refund is a new transaction, the transaction amount can be fully or partially refunded, and will show up as a separate transaction in your customer’s bank account.

Reversal

Step 1

Log into your PrestaShop Admin, from the left menu bar navigate to Orders. Locate the transaction you wish to reverse and click on it. Please note that the transaction must have happened on the same day (before 00:00 CET/CEST) for it to be classified as a reversal.

Step 2

You will now be able to see all the order details and have the ability to view and edit the order. At the top of the page, under the order number there is a row of buttons, the last button in the row should be grey and labelled Reverse order, click on it.

Step 3

Once you have clicked the reverse button the page will refresh and a confirmation message will appear. Please note that you will not be asked to confirm the reversal request, so be careful to only reverse orders you are sure of. Your order status should also now say Cancelled.

Refund

Step 1

Log into your PrestaShop Admin, from the left menu bar navigate to Orders. Locate the transaction you wish to refund and click on it. Please note that the transaction must be at least one day old before it can be classified as a refund.

Step 2

You will now be able to see all the order details and have the ability to view and edit the order. At the top of the page, under the order number there is a row of buttons, the last button in the row should be grey and labelled Refund order, click on it.

Step 3

You will be redirected to a new page and will be asked how much you want to refund, how many pieces you want to refund and given the option to add reason for refund. We will automatically fill the full refund amount into the refund amount box, however, you can edit this to be any amount as long as it is equal to or less than the sale amount.

Step 4

Once you are satisfied with the information you have provided, click on Refund via Truevo Gateway. You will be redirected back to the order information page and a confirmation message will display on the screen. Your order status should also now say Cancelled.

How to capture a payment

Need to secure payment for a future purchase but don’t want to take a deposit? Pre-authorisation is the solution for you. Using pre-authorised payments lets you hold the desired amount and only capture the payment once the product or service has been delivered, this feature is particularly useful if you are in the hospitality industry, have an appointment-based business or make products to order.

Please take note

This feature will only work if you set up pre-authorisations during your application and onboarding process. If you did not set this up and would like to please contact our support team.

Step 1

Log into your PrestaShop Admin, from the left menu bar navigate to Orders. Locate the transaction you wish to capture and click on it, the order status should be On Hold.

Step 2

You will now be able to see all the order details and have the ability to view and edit the order. At the top of the page, under the order number there is a row of buttons, the last button in the row should be blue and labelled Capture Pre-Authorisation, click on it.

Step 3

The screen will refresh and a confirmation message will appear, your order status will also change to Processing.

Page Contents