Summary

Introduction

Welcome to the documentation for the AXEPTA BNP Paribas module for WooCommerce.

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, and tailored integration for your needs.

Must have

You must have a fully functional WordPress site and a WooCommerce module.

Plugin Setup

Installation via the WordPress interface

For a quick and easy installation, you can download and install the plugin directly from the WordPress admin interface. Follow these steps:

1. Download the plugin ZIP file.
2. In the WordPress dashboard, go to "Plugins "> "Add New".
3. Click "Upload Plugin", then select the ZIP file you downloaded.
4. Click "Install Now", and once the installation is complete, activate the plugin.

Installation via FTP/SSH

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 using 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 that folder.
6. Open the WordPress admin area, go to ''Plugins'' > ''Installed Plugins'', and ''activate'' the plugin.

Update Plugin

Before any installation, we invite you to 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 done, you can install the latest update.

Back Office

Plugin Global Settings

The module’s features are accessible through the left‑hand menu in the admin interface ''WooCommerce'' > ''Settings''. To begin configuration, simply click the ''Axepta BNP Paribas'' option.

• Documentation Axepta BNP Paribas : links to our official module documentation.
• Test your configuration : allows you to verify that the site environment is compatible with the installed module.

• Contact support : Enables the opening of an email‑submission form to contact our support team. In this email, the server, CMS, and module versions are sent automatically

Download the LOG file : Allows you to download the logs in the desired format.

Account Settings 

 Demo mode

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

Test mode 

• The test MID is available in the “View API credentials” section of your Axepta BNP Paribas Merchant portal.

• The test REST API key is also available in the “View API credentials” section of your Axepta BNP Paribas Merchant portal.

This allows you to configure your dedicated test MID, which can be identified by the format BNP_MID_t that you can retrieve from your BNP Paribas merchant portal.

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

Production Mode

• The production MID is available in the ''View API credentials'' section of your Axepta BNP Paribas merchant portal.
• The REST API key is also available in the ''View API credentials'' section of your Axepta BNP Paribas merchant portal.

Allows you to configure your dedicated production MID, which is recognizable by the format (BNP_MID_XXX) available from your BNP Paribas merchant portal.

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

Front‑end activation: 

Activating this feature is required to display the payment methods on the checkout page.

SMTP configuration

Activation of the SMTP (Simple Mail Transfer Protocol) feature used to send e‑mails from a server.

Once activated, a new tab “Feature configuration” becomes available.

Image Modified

Payment Method Configuration

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

 A tab labeled « Payment Methods Configuration » appears just below « Account Configuration ». Click on it to open the section and configure your payment methods:

The payment configuration tab lets you set up several 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 payment form is hosted by BNP Paribas, you will see the payment methods available in your account.

Image Added

• Choose the payment method on the merchant’s site

If applicable, this option lets the customer select the payment method directly on your shop before being redirected.

Image Added

Image Added

Image Added

Capture mode

This option allows you to choose the payment capture method.

Image Added

Automatic capture activation

Automatic (J): The capture will be performed automatically at midnight.

Image Added

Deferred capture activation

Deferred (J + x): You can choose the delay before the capture (delay in hours: an integer between 1 and 696).

Example:

to set a 2‑day delay, enter 48.

Image Added

Manual Capture Activation

Manual Capture: The capture is performed manually by the merchant through a configuration in the back‑office.

Image Added

To manually capture a transaction, follow these steps:

1. Go to ''WooCommerce'' >'' Transactions'' from your WordPress dashboard.
2. You will see the list of processed transactions.
3. When you hover over a row that corresponds to a transaction that has not yet been captured, a blue ''Capture'' button will appear below that row.
4. Click the ''Capture'' button to perform the payment capture.

Once the capture is completed, the transaction status will be updated to reflect the action.

Image Added

Manual capture notifications

When a manual capture of a payment is attempted, notifications are displayed to keep you informed about the operation’s status:

• Successful capture: 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 redone.
• Failed capture: In case the capture fails, a detailed notification explains the reason for the problem and guides you on the steps to take.

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

3DS Exemption

It corresponds to the 3DS settings (the payment authentication method) and its exemption based on the total customer's cart amount.

One‑Click activation

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

To do so, the customer must first check the ''Save card'' option on the payment page.

Image Added

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.

Label: Text to display on the block

List of Payment Methods: Select the payment methods to display during the checkout.

Subscription

To enable subscription payment, please go to Payment Methods

In the Subscriptions section, turn on Pay by subscription

Feature Configuration

Click on « Feature Configuration » to open the dedicated section. You will find the option to choose « payment capture mode », allowing you to define how transactions will be processed.

Capture Method

This option allows you to choose the payment capture method:

• Automatic (J) => Payment will be automatically captured at midnight.

• Deferred (J+x) => You can choose the delay before capture (delay in hours: integer between 1 and 696. Example for 2 days: enter 48)

• Manual Capture => Manual capture is performed manually by the merchant through a configuration in the back-office.

Activation of Automatic Capture:

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

Activation of Deferred Capture:

 Deferred capture is configured with a number of hours before the capture is to be performed.

No action is required by the merchant to perform the capture. It is confirmed by a return flow (IPN).

Activation of Manual Capture:

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

To manually capture a transaction, follow these steps:

1. Go to WooCommerce > Transactions from your WordPress dashboard.

2. You will see the list of transactions that have been made.

3. When you hover over a line corresponding to a transaction that has not yet been captured, a blue "Capture" button will appear below that line.

4. Click this button to perform the payment capture.

Once the capture is complete, the transaction status will be updated to reflect the action.

Manual Capture Notifications Notifications are displayed during the manual capture attempt of a payment to keep you informed of the operation status:

1. Successful Capture: A notification informs you that the capture was successfully completed.

2. Already Captured: If the transaction has already been captured, an alert indicates that the capture cannot be redone.

3. Failed Capture: In case of capture failure, a detailed notification explains the reason for the problem and guides you through the steps to follow.

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

Creation of subscription products

In WooCommerce → "All Products". Open the product to be sold as a subscription (or create a new one)

In the "Subscription settings options" block, check: "Activate subscription for this product"

Once enabled, you can configure the following settings:

Billing frequency

• Interval: the number (e.g. 1, 2, 3...)
• Frequency: Days / Weeks / Months / Years

Examples:

• 1 + Month → billed every month
• 2 + Weeks → billed every 2 weeks

Duration (number of occurrences)

• Number of occurrences = number of times the customer will be charged.
• Example: 3 → 3 payments in total (depending on the frequency chosen)

Amount

• Subscription price (before tax): amount charged each period

Register/update the product.

Dashboard

A new column titled "Capture Status" has been added to the order list in WooCommerce.

This column indicates whether the payment transaction has been captured or not. If the capture has not yet occurred, the time elapsed since the capture request will be displayed.

Additionally, a new status "Pending Payment Capture" has been added to the WooCommerce order statuses. This status is only assigned to orders for which the payment capture has not yet been completed. It clearly differentiates orders awaiting capture from those whose payment has already been finalized.

Refund / Cancelllation

Refund

1. Go to WooCommerce > Orders and click on the order you wish to refund.

2. On the order page, you will find the relevant information about the order.

3. You will see a "Refund" button. Click on it to open the refund section.

4. Once the section is open, you can enter the "refund amount" as well as the "refund reason" which is optional.

5. After filling in the fields, click on "Refund X.XX € with Axepta BNP Paribas" to proceed (X.XX is the entered refund amount) with the refund. The refund will be processed if the order has already been captured.

Full Refund

For a full refund, the amount (subtotal) is displayed, and you simply need to leave the predefined values blank and confirm (Refund Offline).

Partial Refund

For a partial refund, you need to adjust the field values. The "Adjustment Fee" field allows you to modify the amount to be deducted from the refund. For example: Subtotal = 45, Adjustment Fee = 15, clicking on "Update Totals" results in a refund of 30 for the buyer.

Cancellation

If the transaction has not yet been processed by the bank (status "processing" when clicking on the order ID), cancellation is possible via « WooCommerce > Transactions ».

Cancellation

To cancel an order whose payment has not yet been captured, follow these steps:

1. Go to WooCommerce > Transactions.

2. Search for the transaction associated with the order number you wish to cancel, and ensure that payment capture has not yet been completed.

3. Once the transaction is located, click the "Cancel" button to cancel the order

Logs

Logs are always enabled. To view or download them, go to « WooCommerce > Status > Logs » and select the log « axepta-bnpp ». On the next page, you can view the logs and download them by clicking the « Download » button.

Subscription table

In the WooCommerce → Subscriptions tab, you will find the list with:

• The initial order
• The customer
• The product
• periodicity
• The last execution
• the next execution
• status (e.g., Active)

On each subscription line, an "Action" menu allows you to carry out management operations.

Stop a subscription

Action: Stop a subscription

Effect:

• The subscription goes to stop (there will no longer be automatic renewal).
• The customer will no longer be charged from that point forward.

Refund a transaction without breaking the subscription chain

Action: Refund a transaction without breaking the subscription chain

Effect:

• You refund the last transaction (a payment) related to the subscription,
• without stopping the subscription: the next renewals remain scheduled and will continue.

Front Office

Checkout Page Display

The payment methods are displayed in a block-specific frame.

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

Checkout Page Display in Redirection Mode

Confirmation Page display

Customer Account

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