Summary

Introduction

Welcome to the documentation for the AXEPTA BNP Paribas module for Magento 2.

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 that meets your needs.

Must Have 

You must have a fully functional Magento module.

Plugin Setup

The installation of the module proceeds as follows:

• Download the module zip file and then unzip it

• Go to the root directory of your site

• Create the following folders:

  • app/code/Bnpparibas

  • app/code/AxeptaBnpparibas/Online

• Copy all the contents of the unzipped module into the directory “app/code/Bnpparibas/Axepta”

• Return to the root of your site and run the following commands:

  • php bin/magento setup:upgrade

  • php bin/magento cache:clean

  • php bin/magento cache:flush

Update Plugin

Before any installation, we invite you to properly 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 “Axepta BNP Paribas.” To start the configuration, simply click on the option “Payment Methods Settings.”

• Axepta BNP Paribas documentation : Links to our official module documentation.
  
• Contact support : Opens an e‑mail form to reach our support team. The e‑mail automatically includes the server, CMS and module versions.

• Verify my configuration: opens a window that displays and checks whether the server configuration is compatible with the installed module.

• Log download: This feature allows you to download logs in the format of your choice.

Account Settings 

Demo mode 

Demo mode (''DEMO'') lets you 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.

Payment Method Configuration

The payment‑configuration tab lets you set up multiple module features.

Payment Methods Organization

This section defines how payment options are displayed on the checkout page.

Two options are available:

• Payment method selection on the BNP Paribas page

This corresponds to the payment form hosted by BNP Paribas, where you will see the payment methods that are available for your merchant account.

• Merchant’s site payment methods selection panel 

Front label: customizable text that appears on the payment page.

Display mode

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

iFrame mode: embeds the payment page directly into your site.

Capture mode 

This option allows you to choose the payment capture method.

Automatic capture activation:

Automatic Capture (J): The capture is performed automatically at midnight.

Deferred capture activation:

Deferred Capture (J + x) – You can define a delay before capture (delay expressed in hours, integer between 1 and 696).

Example:

for 2 days, enter 48. 

Deferred captures appear as "Capture timed" on "Sales" > "Orders", followed by the capture date and time.

Manual capture activation:

Captured manually by the merchant via back‑office configuration.

To manually capture a payment, you must invoice the order.

For that go to the order that needs to be invoiced and click "Invoice".

Select "Capture online" to manually capture the order when issuing the invoice.

Online capture: The online capture performed from the Magento 2 back‑office connects to the Axepta back‑office. The transaction status is automatically synchronised between the two systems.

Offline capture: The offline capture simply generates the invoice and marks the order as "processing", indicating that the amount has been received manually.

Capture Method

This option allows you to choose the payment capture method:

• Automatic (J) => The capture will be automatically processed at midnight.

• Deferred (J+x) => You can choose the delay before the 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, the payment flows are automatically configured for capture to be performed at midnight.

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."

3DS Exemption

Corresponds to the configuration of 3DS (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 “save card” checkbox on the payment page.

Payment Methods

You can enable or disable (‘yes’/‘No’) the subscribed payment methods. To do this, go to the "list of payment methods" section available from the "Payment Methods Configuration" tab.

Customization

Subscription feature configuration

Allows you to enable or disable the subscription payment method on the store. When this option is enabled, customers can select this payment mode if their cart contains a product configured as a subscription.

Creating a subscription product page

In "Catalog" > "Products", open the product you want to sell as a subscription (or create a new one).

The "Active" field lets you enable or disable the subscription product record ("yes" / "no").

Billing frequency

• All: specifies the numeric value for the interval (e.g., 1, 2, 3 …).
• Frequency: sets the frequency unit in Days, Weeks, Months or Years.

Example:

1+Month → Billing occurs every month

15+ days → Billing occurs every 15 days

• Expires after : number of installement that determine the end of the subscription, more specifically the number of times the customer will be billed.

Example: 

3 → 3 total payments (according to the chosen periodicity).

• Recurring amount: The amount charged for each billing period.

Manage ongoing subscriptions

In the “Axepta BNP Paribas” tab → “Subscription List Management”, you can view the list of subscriptions.

You’ll find a list of all subscriptions with the following informations:

Stop a subscription

You can change the subscription status to activate it or stop it.

Action: Deactivate a subscription

Effect:

• The subscription is set to “stopped” (no further automatic renewals).
• The customer will no longer be billed from that moment onward. You can reactivate it at any time by clicking “Activate.”

Action: Delete a subscription

Effect:

• Permanently removes all future billing for the subscription.
• The customer will no longer be billed from that moment.

Installment configuration 

• Payment label: Customizable text that appears on the payment page.
• Minimum amount: The minimum cart total for which the multi‑installment option will be offered.
• Maximum amount: The maximum cart total for which the multi‑installment option will be offered.
• Installments (2X – 3X – 4X): Activate the desired number of installments (choose "yes"/"no").

Number of installments: indicates the percentage distribution of the total cart amount across each installment.

Example of a 3‑installment payment for a total amount of €100:

• 1st installment – 50 % → €50
• 2nd installment – 25 % → €25
• 3rd installment – 25 % → €25

Refund / Cancellation