Summary

Introduction

Welcome to the AXEPTA BNP Paribas module documentation for PrestaShop

This free module allows you to easily integrate our online payment solution into your e‑commerce store.

This documentation will guide you through the installation, configuration and use of the module, ensuring a simple, reliable integration that fits your needs.

Must have

You must have a fully functional PrestaShop installation.

Plugin Setup

Installation via the PrestaShop interface

FTP/SSH Installation

If you prefer a manual method or have restrictions on the WordPress interface, you can install the plugin via FTP or SSH by following these steps:

1. Download the plugin ZIP file and unzip it on your computer.
2. Connect to your server via FTP or SSH.
3. Navigate to the wp‑content/plugins directory of your WordPress installation.
4. Create a folder named axepta-bnp-paribas.
5. Copy all the unzipped plugin files into this folder.
6. In the WordPress admin panel, go to “Plugins” > “Installed Plugins” and activate the plugin.

Update Plugin

Before proceeding with any installation, we recommend that you fully uninstall the current extension, clear your CMS cache, and verify that the extension has been removed by deleting the module’s installation directory from your FTP server.

Once this is completed, you can install the latest update.

Back Office

Plugin Global Settings

The module’s features are accessible from the left‑hand menu in the admin interface under “Customize.” To begin the configuration, simply click on the “Axepta BNP Paribas” option.

The settings page displays several buttons at the top.

Contact support: Opens an email form to reach our assistance team. This email automatically includes the server, CMS, and module versions.

Documentation Axepta BNP Paribas: Links to the official documentation of the Axepta Prestashop module.
Check your configuration: Allows you to display and verify in a window that the site environment is compatible with the installed module.

Download the LOG file: Allows you to download the log file associated with the module’s usage.

Account Settings

Demo Mode

The demo mode (“Demo”) allows you to test the module and its features without needing an Axepta BNP Paribas account.

Test mode

• Test MID (available in the “View API credentials” section of your Axepta BNP Paribas Merchant portal)
• Test REST API key (available in the “View API credentials” section of your Axepta BNP Paribas Merchant portal)

This allows you to configure your dedicated test MID, which is recognizable by the format BNP_MID_t provided through your BNP Paribas merchant portal.

 Accès aux identifiants de l’API & HMAC - Documentation Axepta BNP Paribas - Axepta

Production mode

• Production MID (available in the “View API credentials” section of your Axepta BNP Paribas Merchant portal)
• Production REST API key (available in the “View API credentials” section of your Axepta BNP Paribas Merchant portal)

Allows you to configure your dedicated production MID, which can be identified by the format (BNP_MID_XXX) provided in your BNP Paribas merchant portal.

 Accès aux identifiants de l’API & HMAC - Documentation Axepta BNP Paribas - Axepta

Front‑end activation:
The module must be enabled in order for the payment methods to appear on the checkout page.

Payment Method Configuration

You can now select the different payment methods to activate on your store.

A "Payment Configuration" block allows you to configure the display of payment methods on the checkout page as follows:

Image Removed

All payment methods integrated into the library are presented here. It is up to the merchant to select the payment methods they have subscribed to. The activation key no longer allows defining the payment methods.

Payment Organization:

This refers to the display of payments that has been decided on the checkout page.

• Grouped: Payment blocks appear. It is possible to configure payments for redirection and iframe.

• HPP (Hosted Payment Page): Only redirection is possible with all payment methods grouped into a single button. A complete block is displayed, with no differentiation between cards and other payment methods.

Display Method:

• Redirection: During the payment phase, the user is redirected to a page based on the selected payment method.

• Iframe: During the payment phase, the form is displayed at the bottom of the checkout page based on the selected payment method.

The payment configuration tab allows you to set up multiple features.

Image Added

Payment Methods Organization

This setting determines how the payment options are displayed on the checkout page.

Two options are available:

• Choose the payment method on the BNP Paribas page

The customer is redirected to a payment form hosted by BNP Paribas, where they will see all payment methods available on your merchant account.

Image Added

• Choice of payment methods on the merchant’s website

Image Added

Image Added

Image Added

Display mode

Redirection mode : redirects the customer to the secure payment form hosted by Axepta BNP Paribas.

Image Added

Iframe mode: integrates the checkout page directly into your site.

Image Added

Capture mode

This option allows you to choose the payment capture method :

Image Added

Activation of Automatic Capture

Automatic (J)

: The capture will be performed automatically

at midnight.

Image Added

Activation of manual capture

Manual

capture is performed manually by the merchant through a back‑office configuration

.

Activation of Automatic Capture

When automatic capture is selected, payment flows are automatically captured at midnight.

Image Added

How to capture a transaction manually

1. Go to “Customize” > “Axepta BNP Paribas” > “Transaction.”
2. You will see the list of processed transactions.
3. When you hover over a line that corresponds to a transaction that has not yet been captured, a “Capture” icon will appear in the Action column.

Image Added

      4. Cliquez sur ce bouton pour effectuer la capture du paiement.

Image Added

Une fois la capture effectuée, le statut de la transaction sera mis à jour pour refléter l’action.

Manual capture notifications

Notifications are displayed when attempting a manual payment capture, keeping you informed about the status of the operation.

• Capture successful: A notification informs you that the capture was completed successfully.
• Capture already performed: If the transaction has already been captured, an alert indicates that the capture cannot be re‑executed.
• Capture failed: In case of a capture failure, a detailed notification explains the reason for the problem and guides you on the next steps.

These notifications allow you to precisely track the status of each transaction and act accordingly.

Deferred capture is configured with a specified number of hours before the capture is executed. The maximum allowed delay is 696 hours (29 days).

In the merchant configuration menu, scroll down to the "Capture" field and select "Manual Capture."

Image Removed

Manually capture transactions

To manually capture a payment, go to the transaction list and click on the capture icon in the action column.

Image Removed

Payment Methods

3DS exemption

Corresponds to the configuration of 3DS (the payment authentication method) and its exemption based on the total amount of the customer’s cart.

One-click activation

Activating this feature allows logged‑in customers to save their card for future payments.

To do so, the customer must first tick the option to store their card on the payment page.

Image Added

Payment Methods

 You can enable or disable the subscribed payment methods in the "Payment methods" tab.

Image Added

Image Removed

This block allows the activation of the different payment methods by card or Wallet:

Select the payment methods to display at checkout. If CB- Visa-MasterCard is activated, the CB logo will only appear if the country of delivery of the order is France

The Apple Pay and Google Pay settings allow you to display logos on the checkout page but require you to have subscribed to the option on the contract to see the display on the payment page.

PayPal is a Wallet that must be set up upstream on your Axepta account. It is necessary to communicate the PayPal PayerID to Axepta in advance.

Customization

Allows configuration of the fields sent in the payment form during the redirection.

Image Removed

The ISO codes to ignore represent the ISO country codes if you have modified the configuration of your countries for carriers.

For example, FR (France) is not to be sent because it's in Europe, while US (United States) is to be sent.

Creation of subscription product

Creation of subscription product

installation du cron sur Prestashop

In order to automate the execution of certain tasks (such as triggering subscription payments), you need to configure a scheduled task (cron) on your server.

• 1) Access the cron configuration

On a Linux server, open the terminal and run the following command:

crontab -e

This command allows you to edit the list of scheduled tasks for the current user.

• 2) Add a cron task 

Add the following line to the file:

* * * * * php [PRESTASHOP_MODULE_PATH]/axepta2/run.php action=triggerSubscriptionPayment

• 3) Define periodicity

The five asterisks (* * * * *) define the execution frequency:

* * * * * → every minute

You can adjust this frequency to suit your needs (for example, hourly, daily, etc.).

To help you generate an appropriate cron expression, you can use the following online tool: https://crontab.guru/

Creation of subscription product page 

In Prestashop > "Catalog" > "Products"In Prestashop > Catalog > Products, open the product to be sold as a subscription (or create a new one).

In the Modules tab > "Axepta BNP Paribas", click on the "Configure" button

Image Modified

Activate a subscription on the product by filling in the various fields useful for configuring a subscription:

Image Modified

Activate subscription for this product: Check the box that will determine your product as a subscription product.

Billing frequency 

Subscription periodicity interval: 

• Specify the number for the interval (e.g.

• , 1, 2, 3, …).

Frequencies:

• Day(s) /

•  Month

Image RemovedImage Added

Example:

1 + Month → billing every month

15 + Days → billing every 15 days

Duration (:

• The number of occurrences

• equals the number of times the customer will be

• billed.

Example:

3 → 3 payments in total (

according to the

chosen periodicity)

Amount:

• Subscription price (

• pre‑tax): amount charged for each period

RegisterSave / update the product.

Dashboard

Order statuses have been added to help you view payments in test, demo, or production environments.

Image Removed

Please note that payments made in demo mode require being in Demo mode to be visible.

Manual Capture 

Manage ongoing subscriptions

Image Added

In the "Axepta BNP Paribas" > "Subscriptions" tab you will

Logs

Logs are always enabled. You can download them using the button at the top of the settings screen.

Refund/ Cancellation

To refund a transaction, you must first select the store where the order was placed (top right of the screen). A refund can only be processed for a single store at a time.

Next, go to the customer's order in the transaction details (as previously indicated) and click on "Partial Refund" in the "Order" tab to create a gift certificate :

Image Removed

You will be redirected to the "Product" tab of the same page. Follow these steps to process a partial refund:

1. Select the amount to refund (either total or partial). The amount cannot exceed the total order amount, and the quantity cannot exceed the originally purchased quantity.

2. Click on "Partial Refund":

3. After saving the amount, while still on the order details page, go back to the product details:

4. Select the transaction to be refunded

5. Choose a gift certificate option

6. Click "Refund"

7. You can specify a partial amount if needed

8. The product will now appear as "refunded" in the order details

Full Refund

Multiple partial refunds can be processed. However, the total of all partial refunds cannot exceed the original order amount.

Cancellation

If the transaction has not yet been processed by the bank (captured), cancellation is possible.

Transactions list

Subscription table

Image Removed

In the Axepta BNP Paribas tab > Subscriptions: find the list of subscriptions:

Image Removed

• Subscription ID

• Subscription

• product

• Order

• Customer

• Amount

• Subscription status

• Periodicity

• Date of the last installment
• Date of the next

• installment

For each subscription line, an "Action" menu allows you to perform management operations.You have the option to change the status of the subscription to turn it on or off. 

Stop a subscription

Action :Stop  Stop a subscription

Effect :

• The subscription

• is set to stopped (no further automatic renewals).
• The customer will no longer be

• billed from that

• moment onward.

Font Office

Checkout Page Display

Image Removed

Payment methods are displayed in designated blocks.

Additional payment options are accessible by selecting "More payment options," which only appears when applicable.

Payment Page Redirection Display

Image Removed

Refund a single installment only

Action : Refund a transaction without breaking the subscription chain

Effect :

• You refund the latest transaction (a payment) linked to the subscription,
• without stopping the subscription: future renewals remain scheduled and will continue.

Refund/ Cancellation

Refund

1. Go to "Sell" > "Orders".
2. Click on the relevant order.

Image Added

Click on "Partial Refund" in the "Order" tab.

Image Added

Enter the quantity of product units to refund; this will update the refund amount based on the price of the selected product(s).

Image Added

Click on "Partial refund" once it’s done, repeat the action lower down in the Axepta BNP Paribas tab.

Image Added

In "Transaction", select the credit note generated for the order.

In "Order credit note", select the amount of the generated credit note.

Click "Refund".

The product will now appear in the order details as "refunded".

 Image Added

Cancellation

If the transaction has not yet been settled (captured), a cancellation is still possible.

Customer Account

Orders and subscriptions display an Axepta block in the customer area.

Installing a cron for prestashop

In order to automate the execution of certain tasks (such as triggering subscription payments), it is necessary to set up a scheduled task (cron) on your server.

Access the cron configuration

On a Linux server, open the terminal and run the following command:

crontab -e

Use this command to edit the current user's list of scheduled tasks.

Add the cron job

Add the following line to the file:

* * * * * php [PRESTASHOP_MODULE_PATH]/axepta2/run.php action=triggerSubscriptionPayment

• Replace [PRESTASHOP_MODULE_PATH] with the full path to your PrestaShop installation.
• This command executes the script to trigger subscription payments.

Define the periodicity

The five asterisks (* * * * *) define the frequency of execution:

* * * * * → every minute

You can adjust this frequency as needed (e.g. hourly, daily, etc.).

To help you generate a suitable cron expression, you can use the following online tool https://crontab.guru/