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

You can now choose 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:

All payment methods integrated into the library are presented here. The merchant must select the payment methods they have subscribed to.

The activation key no longer defines the payment methods.

Payment Organization. This refers to the display of payments decided on the checkout.

• Grouped : The payment blocks appear. It is possible to configure payments in 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.

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

Manually Capture the Transaction :

To manually capture a payment, you need to invoice the order. Go to the page of an order to be invoiced, then click on "Invoice."

Next, select "Capture online" to manually capture the order upon invoice issuance.

Capture online: The online capture performed from the Magento 2 back-office will connect to the Axepta back-office. The transaction status is automatically synchronized between the two back-offices.

Capture offline: The offline capture will simply generate the invoice and mark the order as being processed, indicating that the amount has been received manually.

Partial Capture: It is possible to capture only part of the order if it contains multiple items by modifying the quantities in the column. In this case, shipping fees will always be captured on the first invoice. For subsequent payments on the same order, shipping fees will not be included.

Alert Messages: If you attempt to invoice an order whose payment has already been captured, an alert message "The order has already been captured" will appear at the top of the page as follows:

Notifications have also been added when the capture has already been performed, as well as when a payment has not been captured for more than 7 days. The update occurs once a day.

These notifications are visible by clicking on the icon in the top right corner of the screen:

Paiement par Abonnement

Allows you to activate or deactivate the subscription payment method on the store. When enabled, customers will be able to choose this payment method if their cart contains a product that is set up as a subscription.

Payment Method Customization

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

Création of subscription products 

In Magento > >Product Catalog, open the product  sale as a subscription (or create a new one).

In the Subscription settings option by Axepta BNP Paribas tab, you can activate a subscription on the product by selecting Yes.

All: determine the number over the interval (e.g. 1,2,3 ...)

Periodicity: Day(s) / Week(s) / Month / Year(s)

Example:

• 1 + Month → billed every month
• 15+ Days → billed every 15 days

Expired after:

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

Amount

• Recurring amount : The amount billed each period

Register/update the product.

Dashboard

Two columns have been added to the order table: one to indicate the type of capture used for the order (automatic, manual, or deferred), and another to indicate whether the payment has been captured from the Magento back-office. A capture performed on the Axepta back-office does not update this order table, but an alert is provided if an attempt is made on an already captured transaction (see alert notifications).

Deferred captures are indicated as "Capture: timed" followed by the date and time when the capture was performed.

Refund / Cancellation

To perform a refund or cancellation (where possible), go to the Sales > Orders tab to view the details of an order.

1) Select an order from the list, then click "View" to see the order details.

2) Go to "Invoices" and then select the invoice that was automatically created for the order.

3) Select "Credit Memo." You will then have all the information regarding the order, and at the bottom of the page, the fields to fill out in case of a refund

Full Refund

For a full refund, the amount (subtotal) is displayed, and you just need to leave the predefined values blank and validate (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, by clicking on “Update Totals” you get 30 as a refund for the buyer.

Cancellation

If the transaction has not yet been settled (status "processing" when clicking on the orderID), a cancellation is therefore possible.

To check if the transaction has been canceled or fully refunded, go to "Axepta" > "Transaction" to view the list of transactions:

In the "Type" column, it will be indicated as "Cancellation" for a cancellation or "refund" for a refund.

Subscription table

In the Axepta BNP Paribas tab > Subscription List Management: find the list of subscriptions.

• Subscription ID
• Order ID
• The customer
• The Subscription Product
• Transaction ID
• Periodicity
• The start date
• The date of the next execution.
• The amount
• The status of the subscription

You have the option to change the status of the subscription to turn it on or off. 

Deactivate a subscription

Action: Deactivate 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.

Logs

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

Front Office

Checkout Page Display

Payment methods are displayed in a designated frame per block.

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

Checkout Page Display in Redirection Mode

Confirmation Page display

Customer Account

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