WooCommerce Plugin User Guide

PayXpert - User documentation

WooCommerce Plugin User Guide

Latest Version: Version 2 of the plugin [entirely new release].

Not to be installed over previous version. Before installing this module, please uninstall and remove the previous version, if you were using it.

Wordpress 6.0 and above / WooCommerce 7.6.0 and above - User guide for v2.0.0 of the PayXpert extension

1. Introduction

The PayXpert payment module allows you to integrate the Connect2Pay payment gateway into your WooCommerce store.

It supports multiple payment methods, recurring subscriptions, and transaction logging.

2. Requirements

The minimum PHP version required for the server is 7.2.

The minimum WordPress version is 6.0.

The minimum WooCommerce version is 7.6.0.

3. Module Installation

  1. Log in to the WordPress backend.

  2. Go to Plugins > Add Plugin.

  3. Click the "Upload Extension" button.

  4. Import the payxpert.zip file from our documentation or our Github page.

  5. Click Install Now.

  6. Once installed, go to WooCommerce > PayXpert.

4. Global Module Configuration

API Keys & Information

Imp1.jpg
  • Server and CMS Configuration Information

  • Contact form for sending information to support: assistance@payxpert.com

  • Enter the sender's ID and password provided.

  • Click the "Login" button.

Payment Settings

Imp2_1.png
  • Capture Mode:

    • Automatic: The transaction is automatically captured in the bank on D+1. The funds in the account will appear on D+X, according to the specific terms of the contract with PayXpert.

    • Manual: The merchant has the option to postpone the bank deposit, for example, to check their inventory. In this case, it is imperative to complete the manual deposit within 7 days to benefit from any guarantee (Liability Transfer). Otherwise, the funds will be automatically deposited into the bank on the 7th day by the module.

  • Email notification for manual captures: Receive an email alert on day 5.

  • Redirection mode: Display the payment block in Redirection or iframe.

    • Not all payment methods are eligible for iframe.

    • Redirection: The payment page appears in a new browser page.

    • iframe: The payment panel appears on the merchant website.

  • PayByLink activation: Activates the button on orders when the status is pending PayByLink payment. This feature allows you to resend a pre-filled transaction request by email based on the initial transaction.

Payment Methods

Imp2_2.png
  • List of Payment Methods: Choose the payment methods to display in the front office:

    • Bank Cards (CB/Visa/MasterCard)

    • American Express

    • Payment in 2 installments by card

    • Payment in 3 installments by card

    • Payment in 4 installments by card

    • ApplePay

  • Activation: via Checkbox.

Personalization

Imp3.jpg

Customization of labels, in French and English

Installment Payment Settings

Imp4.jpg
  • If installment payments are enabled

  • Minimum amount to offer installment payments: The option will only be visible to customers if the cart reaches the minimum amount indicated (and will soon not exceed the maximum amount indicated).

  • Percentage of the first installment: The remaining cart balance will be divided equally among the other monthly payments.

    • For example: for a payment in 3 installments, the first payment will be 50%, the second installment will be 25% of the cart, and the third will be 25%.

  • Customization of labels, in French and English.

Notifications

Imp5.jpg
  • Payment request notification. This option must also be enabled in the PayXpert back office. Contact your account manager to activate it.

  • Enter the email address of the notification recipient.

  • Choose the default language.

5. Daily Use

Transaction Management

Imp6.jpg

You can access your transactions via WooCommerce > PayXpert - Transaction.

This area displays payments, statuses, dates, and amounts:

  • ID: This is the reference created by WooCommerce.

  • Order Number: This is the order reference created by WooCommerce.

  • Transaction ID: This is the number found in the PayXpert order form. This number is used to identify the uniqueness of a transaction.

  • Reference transaction: This is present when one transaction is linked to another, such as in a payment by installments.

  • Amount: Total amount of the shopping cart.

  • Currency: Transaction currency.

  • Payment method: Indicates the payment method used by the customer.

    Operation: Indicates the nature of the operation performed (Sale, Authorize, Cancel, Refund, etc.).

  • Result: Return code from the payment platform.

  • Created on: This is the transaction creation date.

You can also explore a specific transaction. To do this, go to Orders > Click on the order. This displays a block specific to the details of PayXpert payment transactions:

Refunds

  • Manage full or partial refunds directly in the order details.

    • From the order, click on "Refund."

    • Check if you want to restock the items.

    • Enter the amount to be refunded.

    • Enter the refund reason (optional).

    • Click on Refund manually or click on Refund via Credit Cards by Payxpert.

    • The refund will be visible in the transaction details on the WooCommerce e-mail box and as a separate transaction (Refund) on the PayXpert e-mail box.

6. Front office

Displays the payment block when selecting payments.

Redirecting to the Payment Page:

In iframe:

Not all payment methods are compatible with the iframe display mode:

7. Frequently Asked Questions

How do I know if my API key is valid? My key is invalid.

  • When saving the "Your Merchant Account" box (PayXpert/Configuration), a banner indicates the success of the update, and therefore the acceptance of the public and private API keys.

  • In the "CMS Configuration Information" box (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. Otherwise, contact support to obtain new keys.

What payment methods are enabled for my account?

It's important to distinguish between the ability to view the payment method on the Woocomerce BO, on the Front Office (FO) checkout page, and finally, the ability to finalize a transaction with a particular payment method.

On the FO, certain conditions may limit its display. For example, for the ApplePay button to be displayed, the end customer must use an Apple device and Safari. For payment in installments, cart size criteria may limit its presence on the checkout page.

Finally, for a payment to be finalized, the merchant must have the appropriate rights in the PayXpert information system. This is therefore one of the verification steps to complete to answer the question.

Why doesn't ApplePay appear among the payment methods offered on the PrestaShop e-commerce platform?

ApplePay is enabled by default on the payment page.

This payment method does not need to be activated 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-commerce platform allows the ApplePay logo to be displayed on the e-commerce platform.

Why does a transaction always appear as pending?

There are several transaction statuses for the PayXpert module:

  • Payment capture pending (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.

  • Pending Installment Payments (PayXpert)

    • Order statuses for an incomplete installment payment transaction.

  • The other statuses (In Progress, Completed, Failed, Canceled, Refunded, etc.) are native to WooCommerce, 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.

  • You must therefore be careful not to block their arrival in the merchant environment, particularly if the merchant's server blocks certain IP addresses or URLs.

  • Another issue may stem from the email system not being configured or being incorrectly configured in the WooCommerce OB (Settings/Emails).

I can't install my module, and I get an error message.

  • In some client environments, the module may encounter difficulties performing the requested action during installation, update, or configuration.

  • Possible actions:

    • 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 cases of overload or with other installed modules/themes.

  • To check which one is causing the problem, it is recommended to uninstall them, clear the cache, and test the display.

© PayXpert Services Ltd, 2025