Summary

Introduction

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

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

This documentation guides will guide you step by step through the installation, configuration, and use of the module to ensure , ensuring a simple, reliable, and tailored integration to 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

Back Office

Plugin Global Settings

The different module’s features of the tool are available in the left-hand menu of the page. To start configuring the module, you need to click on "AXEPTA". The configuration page displays several buttons at the top.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.”

Image Added

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

Image Added

• Verify my configuration: opens a window that displays and checks whether

• Axepta BNP Paribas Documentation: When clicked, the user is redirected to the official documentation hosted by BNP Paribas.

• Contact Support: Opens a form to send an email to support. The server, CMS, and module versions are automatically included in the email.

Test Configuration: Allows you to display and verify in a window that
• the server configuration is compatible with the installed module.

Image Removed

Account Settings 

Image Added

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

Image Added

Account Settings 

Image Added

Demo mode 

Demo mode (''DEMO'') lets you test the module and its features without having an Axepta BNP Paribas account.

Image Added

Test mode 

Image Added

• 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

Image Added

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

Image Added

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.

Image Added

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.

Image Added

• Merchant’s site payment methods selection panel 

Image Added

Image Added

Image Added

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

Image Added

Image Added

Display mode

Image Added

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

Image Added

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

Image Added

Capture mode 

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:

Image Removed

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.

This option allows you to choose the payment capture method.

Image Added

Automatic capture activation:

Automatic Capture (J)

=>

: The capture

will be

is performed automatically

processed

at midnight.

Deferred

(J+x) => You can choose the delay before the

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)

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

, integer between 1 and 696).

Example:

for 2 days, enter 48. 

Image Added

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.

Image Removed

Activation of Automatic Capture:

When automatic capture is selected, the payment flows are automatically configured for capture to be performed at midnight.

Image Removed

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

Image Removed

Warning
Warning : Without action from the merchant, the transaction will not be settled. Capturing a transaction beyond the 7th day results in the loss of the 3D Secure guarantee. Beyond the 29th day, the authorization granted by the issuer will no longer be valid. It is therefore preferable to capture transactions before these deadlines.

Manually Capture the Transaction :

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

For that go to the page of an order that needs to be invoiced , then and click on "Invoice"."

Image RemovedImage Added

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

Image RemovedImage Added

Capture onlineOnline capture: The online capture performed from the Magento 2 back-office will connect Magento 2 back‑office connects to the Axepta back-officeback‑office. The transaction status is automatically synchronized synchronised between the two back-officessystems.

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

Tip
Partial

Capture

capture: It is possible to capture only a part of the order

if

when it contains multiple items by

modifying

adjusting the quantities in the column. In this case, the shipping fees

will

are always

be

captured on the first invoice. For subsequent

payments on

payment captures of the same order, the shipping fees will not be

included

accounted for.

Warning
Warning: If the merchant does not take any action, the transaction will not be transferred to the bank. Capturing a transaction after the 7th day results in the loss of the guarantee associated with 3‑D Secure. After the 29th day, the authorization granted by the issuer will no longer be valid. Therefore, it is advisable to capture transactions before these deadlines.

Image Removed

Image Removed

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

Paiement par Abonnement

3DS Exemption

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

Image Added

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.

Image Added

Image Added

Image Added

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.

Image Added

Customization

Subscription feature configuration

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

Image Removed

Payment Method Customization

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

Création of subscription products 

Image Added

Creating a subscription product page

In "Catalog" > "Products", open the product you want to sell 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.

Image Removed

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

Image Added

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 daysExpired

• Expires after

• Number of occurrences =  : number of installement that determine the end of the subscription, more specifically the number of times the customer will be chargedbilled.

Image Added

Example:

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

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

• .

Manage ongoing subscriptions

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

Dashboard

Image Added

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.

Image Added

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 

Image Added

• 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

Image Added

Refund / Cancellation

To process a refund or a cancellation, go to the "Sales" > "Orders" section to view the details of the order.

Select the desired

Refund / Cancellation

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

Image Removed

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

Image RemovedImage Added

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

Image RemovedImage Added

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

Image Removed

Image Removed

further down you will find the fields that need to be filled out to process a refund.

Image Added

Image Added

Refund 

Full refundFull Refund

For a full refund, the "subtotal" amount (subtotal) is displayed, and you just need to leave the predefined values blank and validate (Refund Offline)is pre‑filled; you simply need to click on Image Added.

Partial Refund

For a partial refund, you need to adjust the field values of the fields. The "Adjustment Fee" field  field allows you to modify the amount to that will be deducted from the refund.

Example:  You want to refund €30 to a customer because of a delivery delay:

For example: Subtotal = 45, Adjustment

Ajustement Fee = 15, by clicking on “Update Totals” you get 30 as a refund for the buyer.

Click “Update Total” to trigger the refund of the difference.

Cancellation

Cancellation

If the transaction has not yet been settled ( status is "processing" when clicking on the orderID), , it means that the funds have not yet been transferred to the bank, so a cancellation is therefore still possible.

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

Image Removed

In the "Type" column, it you will be indicated as see "Cancellation" for a cancellation cancelled transaction or"refundRefund" for a refund.

Image Removed 

Subscription table

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

refunded transaction.

Image Added

Logs

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

Front Office

Customer Account

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