PayXpert - User documentation
PrestaShop 1.7.5 and above - PayXpert Plugin User Guide
1. Introduction
The PayXpert payment module allows you to integrate the Connect2Pay payment gateway into your PrestaShop store.
It supports multiple payment methods, recurring subscriptions, as well as transaction logging.
2. Constraints
The minimum server php version required is 7.4.
The minimum version of PrestaShop is version 1.7.5.
3. Installing the module
Log in to the PrestaShop back office.
Go to Modules > Module Manager.
Click Add New Module.
Import the payxpert.zip file from our documentation (https://developers.payxpert.com/integrations/plugins ) or our Github page (https://github.com/payxpert )
Click Install.
Once installed, click Configure.
4. Overall module configuration
API Keys & Information
Server and CMS configuration information
Contact form for sending information to support: assistance@payxpert.com
Public and private API key: Provided by email by PayXpert following the opening of the contract
Activation: Yes / No.
Payment Methods
Payment Method List: Choose which payment methods to display in the front office
Yes or No Activation
Hovering over the labels displays additional information.
You can enable/disable methods such as:
Credit card (Visa, Mastercard, etc.)
Apple Pay
Recurring payments (if subscriptions are enabled) - Upcoming feature
Payment Settings
Capture Mode:
Automatic: the transaction is automatically remitted to the bank on d+1, the funds in the account will appear on d+X, according to the specific conditions of the contract with PayXpert.
Manual: The merchant has the option of postponing the bank remittance in order to check his stock, for example. In this case, it is imperative to carry out the manual handover before 7 days in order to benefit from any guarantee (Transfer of liability). Otherwise, the funds will be automatically transferred to the bank on the 7th day by the module.
Notification email for manual captures: Receive an alert by email on d+5
Redirect Mode: Display of the payment block in Redirect or iframe
Not all payment methods are eligible for the iframe
Redirect: The checkout page appears in a new browser page
iframe: the payment pad appears in the merchant site.
Activation of PayByLink: Activates the button on orders when the status is pending PayByLink payment. The feature allows you to send a pre-filled transaction request by email from the initial transaction.
Installment payment settings
If installment payments are enabled
Minimum amount to offer payment in installments: the option will only be visible to customers if the cart reaches the indicated minimum (and soon does not exceed the indicated maximum).
Percentage of the first payment: The balance of the basket will be divided equally among the other monthly recurrences.
For example: for a payment in 3 instalments, the first payment indicated at 50%, the 2nd instalment will be 25% of the basket and the 3rd as well.
Customization
Customization of labels, in French and English
Notifications
Payment Request Notification. Also needs to be activated in the PayXpert backoffice. Contact your account manager to activate the option.
Default language selection
5. Daily use
Transaction management
You can access your transactions via Modules > PayXpert > transactions.
This area displays payments, statuses, dates, and amounts:
Transaction ID: is the number to be found in the PayXpert back office. It is this number that identifies the uniqueness of a transaction.
Reference transaction: is present when chaining from one transaction to another, such as in a payment in installments or a subscription.
Order ID: is the reference created by Prestashop
Transfer of liability: in the event of successful authentication (3DS) by the customer, the merchant benefits from a payment guarantee for 7 days. Limited time for manual capture.
Payment method: Indicates the payment method used by the customer
Operation: presents the nature of the operation carried out (Sale, Authorize, Cancel, Refund, etc.)
Amount: total cart amount
Message: Payment platform return code
Created On: is the date the transaction was created
You can also drill down on a specific transaction. To do this, go to Orders > Order details. This displays a specific tile showing the details of the PayXpert payment transaction:
Subscription Management - Upcoming feature
You can enable recurring products in the catalog.
You can track them via Modules > PayXpert > Subscriptions.
Refunds
Manage the full or partial refund directly in the order detail.
From the details of a transaction, click on "Partial refund". Fill in the quantity and amount to be refunded, select "Generate a credit note" and validate. The refund will be visible in the transaction detail on the Prestashop backoffice and as a full-fledged Refund transaction on the PayXpert backoffice.
6. Front office
Displays the payment block when selecting payments. CB/VISA/Mastercard logos may be hidden or displayed.
In redirection to the Payment page:
In iframe:
Not all payment methods are compatible with the iframe display mode:
Payment link
It is possible from the module's backoffice to send a payment link to your customer for an order, either from a failed transaction or by creating a new order.
To access this service, you must change the status of an order to the following:
In the details of the order, these 4 buttons will then be available (if the payment options in installments are activated):
Your customer will then receive this sample email.
Scheduled Tasks (CRON)
Enable the crons to:
perform transaction synchronization
perform subscription processing
7. Frequently Asked Questions
How do I know if my API key is valid? My key is invalid.
When you save the "Your Merchant Account" panel (PayXpert/Configuration), a banner indicates the successful update, and therefore the acceptance of the public and private API keys.
In the "CMS Configuration Information" panel (PayXpert/Configuration), an icon indicates the validity of the API keys.
If the API keys are invalid, check for spaces before or after the values. If not, contact support to obtain new keys.
What payment methods are enabled for my account?
It is important to distinguish between the ability to view the payment method on the PrestaShop BO, on the Front Office (FO) checkout page, and finally, the ability to finalize a transaction with a particular payment method.
On the PrestaShop website, APMs can be activated without restriction:
On the FO, certain conditions may limit its display. For example, for the ApplePay button to be present, the end customer must use an Apple device and Safari. For payment by installments, cart size criteria may limit its presence on the checkout page.
Finally, for a payment to be finalized, the merchant must have rights in the PayXpert information system. This is therefore one of the verification steps to be performed to answer the question.
Why doesn't ApplePay appear among the payment methods offered on the website?
ApplePay is enabled by default on the payment page.
This payment method does not need to be activated in itself and does not require any action on the part of the customer.
Prerequisites:
Use of an Apple device and Safari by the end customer (older versions of Safari are not compatible with ApplePay)
Use of the redirect display mode
The ApplePay radio button in the payment methods on the PrestaShop e-mail box allows the ApplePay logo to be displayed on the e-mail box.
Why does a transaction always appear pending?
There are several transaction statuses for the PayXpert module:
Waiting for payment capture (PayXpert)
Transaction accepted by the customer with successful authentication. The transaction must be captured (reposited in the bank) before the 7th day to avoid losing the funds.
Awaiting payment via PayByLink (PayXpert)
With this status, you can send an email to a customer, either from a new order created in the order form or from a failed transaction. Once the order is paid, a new order will be processed.
The other statuses (Shipped, Delivered, Payment Error, Payment Accepted, Refunded, etc.) are native to PrestaShop, and the module uses them depending on the situation.
Why am I not receiving email notifications about my activity?
Some information or notifications are not managed by the module itself, but by the payment platform.
It is therefore important to ensure that they do not block their arrival in the merchant environment, particularly if the merchant's server blocks certain IP addresses or URLs.
Another issue may be due to the email system not being configured or being incorrectly configured in the PrestaShop OB (Configure/Advanced Settings/Email).
I can't install my module, and I get an error message.
In some client environments, the module may experience difficulties performing the requested action during installation, update, or configuration.
Possible actions:
Clear the cache: Configure/Advanced Settings/Performance then click "Clear Cache."
Uninstall the module and reinstall the latest version.
Is my checkout page displaying abnormally?
The checkout page is primarily managed by the PayXpert payment module, but conflicts can occur, particularly in the event of overload or with other installed modules/themes.
To check which ones, it is recommended to uninstall them, clear the cache, and test the display.
In the PayXpert module's configuration panel, you can also check for overrides or themes.
© PayXpert Services Ltd, 2025