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

1. The minimum PHP server version required is 7.4.

2. The minimum version of PrestaShop is version 1.7.8.

3. Installing the module

1. Log in to the PrestaShop back office.

2. Go to Modules > Module Manager.

3. Click Add New Module.

4. Import the payxpert.zip file from our documentation (https://developers.payxpert.com/integrations/plugins ) or our Github page (https://github.com/payxpert )

5. Click Install.

6. Once installed, click Configure.

4. Front office

The PayXpert plugin displays the payment block at checkout. CB/VISA/Mastercard and American Express logos may be hidden or displayed. There are two ways to control the payment flow at checkout:

• In redirection to the Payment page:
  
  

Open

• In iframe:

Open

5. Overall module configuration

API Keys & Information

Your API key validates your PayXpert account. Both keys are mandatory.

Open

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

  • Public API Key: the Originator ID

  • Private API Key: the API key provided for this Originator

• Activation: Yes / No.

Payment Methods

Activate card payments, Apple Pay, subscriptions and payment by installment, as desired.

Open

• 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

• Payment by installment

• Recurring payments (if subscriptions are enabled for your account)

Payment parameters

Determine the checkout look and feel and how you want the incoming payments to be treated.

Open

• 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 payment page appears in a new browser page

  • iframe: the payment form 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 a new order or failed transaction.

Installment payment settings

Offer installment payments on your website’s checkout area, determining applicable min and max, and payment fractions to allow.

Open

• Activate installment payments if desired

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

• Maximum amount for installment payments: the module will not offer payment by installment if the cart exceeds this amount

• 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 installments, the first payment indicated at 50%, the 2nd installment will be 25% of the cart and the 3rd as well.

Customization

Control the text that appears for your checkout area options that you have configured for your site.

Open

Customization of labels is possible in French and English.

Open

“Pay in installment” labels

Notifications

If desired, you, as the merchant, can receive a notification each time a transaction is conducted on your site.

Open

• Recipient: where do you want us to send the emails?

• Language: what language do you want these mails in?

6. Daily use

Transaction management

You can view a record of your transactions via PayXpert > transactions.

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

Open

• Transaction ID: is the number to be found in the PayXpert backoffice. 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

Each transaction corresponds to an Order ID:

Open

You can drill down into a specific Order:

Open

Inside these Order details we can see transaction status, and edit invoices and delivery notes.

You can see a list of all orders in Orders > Orders from the main menu. Basic customer and transaction information is given:

Open

Each order has a small, expandable information panel beneath it. This give you more information on the order and the transaction:

Open

This order is an automatic iteration of a subscription product

Payment by link

From the PrestaShop backoffice it is possible to send a PayXpert payment link to your customer for an order, either when a transaction has failed transaction or when creating a new order.

Remember that this must be activated in PayXpert > Configuration > Payment parameters:

Open

For failed transactions

If a transaction for an order has failed with a “Payment error” status, you can send a payment link to your customer so that he/she can try again. To access this feature, first change the status of the order to “Waiting for payment by PayByLink”:

Open

(Alternatively, you can change the status of the order in the Order details…)

Then, open the Order details:

Open

At the bottom of the page, the “PayByLink” button(s) will have appeared:

Open

New orders

If creating a new Order for a customer, make sure that “Payxpert Service” is selected for the Payment module:

Open

…and then “Send pre-filled order to the customer by email”:

Open

Finally, click Create order. Your customer will receive an email like this:

Open

The Order remains in the same status—”Waiting for Payment by PayByLink (PayXpert)”—until the customer completes payment.

Besides new Orders you can also use an existing cart for which the customer did not complete payment:

Open

Sending a Payment link for an unfinished checkout

Alternatively, use a historical Order to generate a new one to send by link.

Subscriptions

Prerequisites

You must also enable subscriptions as a Payment method:

Open

Configure the product

Once you have enabled the Subscription payment method, you can create recurring products in the catalog:

1. In the product catalog, navigate to the Module tab for your product. Click Configure.
   
   

   Open

   

    

2. Configure the module for this product:
   
   

   Open

   

   • Check the Enable box

   • Subscription Frequency: determines when the customer will be billed

   • Subscription Duration Type: The subscription can be fixed to a set duration (number of cycles) or it can be unlimited (to repeat indefinitely):

     • if Fixed duration, define the max. number of cycles:
       
       

       Open

       

        

   • First Payment Timing:

     • If in your “Payment Parameters” you have set your “Capture mode” to “manual”, then you could set the first subscription payment timing as “Deferred”. Remember to capture the payment within the recommended time of 7 days

     • If your “Capture mode” is “automatic” then deferred capture of the first payment will not be possible: the customer will be charged for the first cycle when purchasing the subscription

   • Subscription Price: this amount will be rebilled to the customer for the duration of the product subscription
     
     

3. Click Save and publish to make the product available as a subscription.

Don’t forget to create the necessary label for the subscription product. Go to PayXpert > Configuration > Customization and enter your label’s text:

Open

How it works

The subscription is now on your site. When a customer initiates a subscription with one of these products, the Plugin communicates this to PayXpert, who handles the subsequent iterations.

The PrestaShop module regularly and automatically checks PayXpert to see if the latest iteration has been performed. Installments that are up-to-date in your PrestaShop backoffice will show as ‘s on your home dashboard. Due installments and subscriptions that have not been communicated back yet are shown as’s. To manually refresh the connection, click Synchronize. PrestaShop will ping PayXpert to check for any pending information.

Open

There are 3 new subscriptions awaiting acknowledgement by PayXpert. All installments have been synchronized with the module

You can track your Subscriptions' details via Personalize > PayXpert > Subscriptions.

Open

When a subscription is “Active” it means that there are iterations left. When “Finished”, the subscription product is over.

Each line represents either a new initial subscription signup transaction OR an iteration of an existing subscription, meaning that for each iteration a new Order ID is created. Here, you can expand a subscription installment to see if it is part of a chain of subscription “sales”:

Open

When drilling down on a single Order, you can determine if it is an iteration by checking if there is a referral transaction associated to it:

Open

Order #244 is an iteration of initial subscription Order #239

Subscription refunds and cancellations

You must be careful when offering subscriptions:

• be vigilant for customer complaints

• be ready to refund and cancel any subscriptions if there are issues with customer satisfaction

Refunds

Manage the full or partial refund directly in the order detail. Click "Partial refund". Fill in the quantity and amount to be refunded, select "Generate a credit note" and validate.

Open

The refund will be visible in PayXpert > transactions.

Open

Scheduled Tasks (CRON)

By default, all synchronization between PayXpert and PrestaShop is automatic. However, you can manually refresh the crons to:

• perform transaction synchronization

• perform subscription processing

…before the next scheduled synch.

Open

7. Release history

This table is a summary of the important changes to the past and current versions of the plugin:

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

Open

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:

Open

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

Open

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

Open

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

Open

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.

Open

In Payment methods I see both installments and subscriptions. What’s the difference?

• What's the difference between an installment payment and a subscription?