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

1. The minimum PHP version required for the server is 7.4.

2. The minimum WordPress version is 6.0.

3. The minimum WooCommerce version is 7.6.0.

3. Module Installation

1. Log in to the WordPress backend.

2. Go to Plugins > Add New.

3. Click Upload Plugin.

4. Select or drag & drop the module ZIP file (link found on our documentation page or go directly to our Github).

5. Click Install Now then Activate.

Once installed, go to WooCommerce > PayXpert. Configure the module as described below.

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:

• Redirecting to the Payment Page:

Open

• In iframe:

Open

5. Global 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

• Click the "Login" button.

Payment Settings

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

Open

• 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 Redirect or iframe (see here for differences).

  • Not all payment methods are eligible for the iframe.

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

  • iframe: The payment form 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

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

Open

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

Customization

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

Open

Customization of these two labels, in French and English.

Open

Customizable text

Installment payment label customization is separate; see below.

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

• Customize the Payment in installment labels as desired:

Open

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

Manual status change of the Order

It is important to remember that the WooCommerce payment plugin enables the transaction to take place for an Order. You must manage an Order's status manually. The workflow is a bit different depending on your capture mode:

In automatic capture mode

In an automatic-capture workflow (when the customer pays at checkout):

1. You or your customer creates the order.

2. The customer performs the transaction.

3. Check that the transaction was successful:
   
   

   Open

   

    

4. Now you can mark the Order as “complete”:
   
   

   Open

   

   Order still says “processing”

    

5. Now the Order is complete.
   
   

   Open

   

If you perform manual captures

In a manual capture workflow (when a transaction is authorized and then you capture it):

1. You or your customer creates the order.

2. The customer inputs their card info.

3. Check that the authorization was successful:
   
   

   Open

   

    

Open

4. Drill down on the Order and click Capture:

Open

5. When captured, the order will change to “Processing”:
   
   

   Open

   

6. Now you can mark the Order as “Complete”:
   
   

   Open

   

    

7. The Order is complete.
   
   

   Open

   

Transactions area

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

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

Open

Notice the different types of operations

• ID: This is the reference created by WooCommerce.

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

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

• Amount: Total amount of the shopping cart.

• Currency: Transaction currency.

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

• Operation: Indicates the type of operation performed for this transaction (Sale, Authorize, Cancel, Refund, Capture).

• 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 or click directly on the order. This displays, besides customer and product information, a block specific to the details of the financial transaction:

Open

Transaction info on the Order

A “Referral transaction” is present when one transaction is linked to another, such as in a payment by installments.

Payment by link

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

Remember that this must be activated in WooCommerce > PayXpert:

Open

For failed transactions

If a transaction for an order has failed with a “Failed” status, you can send a payment link to your customer so that he/she can try again. To access this feature, open the failed order:

Open

In the Order actions area, click “Choose an action” and select “(PayXpert) Send PayByLink”:

Open

Click Update. With this action, an email is sent to the given customer email:

Open

If Payment in installments is activated you can alternatively send links for 2, 3 or 4 installment payments:

Open

New orders

Select the customer for the Order you are creating; their email will be used. In the Order actions, choose to “Send order details to customer”:

Open

Finally, click Update. Your customer will receive an email with the payment link.

The Order changes to and remains in “Pending payment” status.

When the customer completes payment (you will see a Transaction for the Order in “Payxpert - Transactions), you can manually mark the order as “completed”:

Open

Pay by link order “pending payment” until complete. An order coming in from the web is “processing” until complete

Refunds

Manage full or partial refunds directly in the order details.

1. Open the order and click "Refund":
   
   

   Open

   

    

2. Give more info on the refund:
   
   

   Open

   

    

   1. Tick “Restock refunded items” if you want to add the item(s) back to your Stock.

   2. Enter the amount to be refunded (partial refunds allowed).

   3. Enter the refund reason (optional).
      
      

3. Click a type of refund:

   • “Refund manually”: this gives the customer store credit on your WooCommerce site. His or her bank card will not be credited.

   • “Refund via Credit Cards by Payxpert”: the customer will receive the amount on his or her actual card balance
     
     

4. Confirm in your browser.

The refund will processed as a new transaction:

Open

Order #204 is referenced both in a sale and then the subsequent refund transaction

In the transaction details for the Order, the original transaction is given as the referral transaction:

Open

Subscriptions

Prerequisites

You must also enable the Payment method setting:

Open

Configure the product

Once you have enabled the Subscription payment method, you can set a product as a subscription

Open

Button in Product > Product data > General. Activates subscriptions for the product

Now configure the “Subscription plan details”:

Open

• Frequency: determines when the customer will be billed

• 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 “Number of occurences” that shall take place:
    
    

    Open

    

     

• First due:

  • 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

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

Finally, click Publish to make the product available as a subscription on your site.

Remember to set the checkout area text your subscription products. Go to WooCommerce > PayXpert > 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, then upon payment (or manual capture, if in “Payxpert” > “Payment settings” > “Capture Mode” is “manual”), PayXpert will handle the future iterations for the length of the subscription.

You can track each Subscription in WooCommerce > 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 the latest action in that subscription chain (one line per subscription lifecycle). For example, we open order 165, which was part of Subscription 1259088:

Open

…we see the four payments that were performed:

Open

When drilling down on a single Order, you can see the first payment in the subscription chain:

Open

Order #174 is an iteration of initial subscription Order #165

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

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

1. They must go to “My account”

2. They must click on “Subscriptions”:
   
   

   Open

   

    

3. They can cancel the subscription by clicking “Cancel”.

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.

What’s the difference between Installment payments and a subscription installment?

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