Elavon downloads and stores cookies on your device when you visit our website. We use these cookies to better understand and improve your browsing experience by identifying most visited pages, personalising content, and measuring site performance.

Essential cookies enable core functionality such as page navigation and access to secure areas. The website cannot function properly without these cookies; they can only be disabled by changing your browser preferences.

These are cookies that support site functionality that is visible or advantageous to you or your experience of the site, they enable websites to remember choices and provide a more personalized experience.   Functional cookies help to provide services that you request, such as language preference or layout.

Performance cookies help us to improve our website by collecting and reporting information on its usage (for example, which of our pages are most frequently visited).

These cookies and similar technologies gather information about your browsing habits. They remember that you've visited a website and share this information with other organisations, such as advertisers and platforms on which we advertise. They do this in order to provide you with ads that are more relevant to you and your interests. Although these cookies and similar technologies can track your visits to other websites, they don't usually know who you are. Without these cookies, online advertisements you encounter will be less relevant to you and your interests.

Cookie Settings

U.S. Bank Europe DAC. Registered in Ireland – Number 418442..  Registered Office: Block F1, Cherrywood Business Park, Dublin 18, D18 W2X7, Ireland.
U.S. Bank Europe DAC, trading as Elavon Merchant Services, is regulated by the Central Bank of Ireland.
 
U.S. Bank Europe DAC. Registered in Ireland with Companies Registration Office. The liability of the member is limited. United Kingdom branch registered in England and Wales under the number BR022122.
U.S. Bank Europe DAC, trading as Elavon Merchant Services, is a credit institution authorised and regulated by the Central Bank of Ireland.  Authorised by the Prudential Regulation Authority.  Subject to regulation by the Financial Conduct Authority and limited regulation by the Prudential Regulation Authority.  Details about the extent of our regulation by the Prudential Regulation Authority are available from us on request.

Most popular solutions

Additional solutions

Fusebox integration & options

Optional platform features

Documentation

North America

Europe

Regions

:::::notice{important}

- The beta period to support shopping cart plugins for Converge in North America ended on December 1st, 2023. We will not add or develop any features for Magento 2.0 or WooCommerce, and all shopping cart-related pages will soon be removed from the developer portal. 
- For more information on compatible shopping carts, please visit [WorksWith](https://workswith.elavon.com/en-US/home) page on elavon.com.
:::::

This guide contains instructions to install the WooCommerce plugin and describes how to utilize all of the plugin’s features.

:::::notice{note}
This plugin is only available for beta testing.
:::::

To get started, you must have the following items:

- Converge Merchant ID
- Converge API User ID
- Converge User PIN
- Download the latest version of the plugin

The plugin is compatible with the Community 5.8.0 version of WooCoomerce.

The plugin has been tested and proven to work with the following browsers: Firefox, Chrome, Internet Explorer and Safari.

## Installation Steps

**Pre-requisites**

Before you can set up your WooCommerce-powered online store, you'll need to install WordPress and the WooCommerce plugin itself.

- Review the mandatory [requirements](https://wordpress.org/about/requirements/) for the operation of Wordpress.
- Read and follow the [instructions](https://docs.woocommerce.com/document/installing-uninstalling-woocommerce/) for installing WooCommerce.

### New Installation

There are two ways to install the Converge WooCommerce Plugin:

**Option 1:**

- Unzip and upload the plugin folder to your **/wp-content/plugins/** directory.
- Log in to WordPress.
    - Select the **Plugins** tab on the sidebar.
    - Scroll down to **WooCommerce Elavon Converge NA Gateway.**
    - Click **Activate.**

**Option 2**

1. Log in to WordPress.
2. Click the **Plugins** tab on the sidebar.
3. Select **Add New** from the dropdown.
4. Click **Upload Plugin.**
    - On the following page, you'll be prompted to select the file that you want to upload and install.
    - Click **Browse** and select the Elavon Converge NA Gateway Extension zip file.
5. Click **Install Now.** The plugin displays in the list when it has been added to the site.
6. Click **Activate** to complete the installation.

### Upgrade from a Previous Version

:::::notice{important}

If there is a previous version of the plugin already installed, you should deactivate and uninstall it before you proceed with installing a new version.
1. Log in to your WordPress Admin Panel.
2. Select the **Plugins** tab.
3. Scroll down to the **WooCommerce Elavon Converge EU Gateway** plugin and click **Deactivate.**
4. After successful deactivation, click **Delete.**
:::::

## BackOffice Configuration

An overview of all transactions and Converge-related settings can be found in the Converge BackOffice:

- [Test Environment](https://demo.convergepay.com/converge-webapp/#!/login)
- [Live Environment](https://www.convergepay.com/converge-webapp/#!/login)

After successful installation, please follow the steps below to configure the various integration options supported by this plugin.

1. Log in to the WooCommerce Admin Panel.
2. Navigate to **Settings** -> **Payments.**
3. Click **Elavon Converge NA Gateway.**

## Converge Gateway Configuration

1. The **Environment** dropdown is used to switch between the *Sandbox* and *Production* environments. 

    - *Sandbox* is selected by default and enables users to test payment methods without using real credit cards.
    - *Production* sends transactions to your Production account. 

:::::notice{note}
 
The credentials for each environment are different.

:::::

2. You will need to enter the following in its corresponding field to begin your configuration:

    - Converge Merchant ID
    - Converge User ID
    - Converge User PIN

3. The **Terminal Name** is provided by Converge once a new terminal is set up. The value for this field displays after you click **Terminal Setup.**

### Basic Converge Payment Settings

1. **Title** - This option allows you to enter a specific title. There is no default value for the title.

2. **Enabled** - By default, this option is set to **NO.** It should be changed to **YES** for the Converge plugin option to show up on your checkout page.

3. **Debug Log** - Debug logging can be enabled if you are having issues with processing transactions correctly. All debugging messages are cleaned of sensitive information before being displayed. However, best practice is not to enable this unless you are having issues with the plugin.

4. **Payment Action** - Select how you want the transaction to be captured in Converge:

    - **Authorize:** Order amount will only be authorized on Credit Card used for the transaction, and merchant will have to capture this amount from WooCommerce.
    - **Authorize and Capture:** Sale transaction will be captured for this option, and no additional action is needed from merchant side for this transaction to be settled.

5. **Integration Method** - Select the integration method:

    - **Lightbox (PCI SAQ A):**  Enable “Lightbox” if you would like to display the Elavon Converge NA Gateway hosted payments page as a pop-up on the WooCommerce payment page (uses java script to show a pop-up window which appears seamlessly, keeping customers on your site for payment).

    - **Checkout.js (PCI SAQ A-EP):** An integration method where the webpage is generated by WooCommerce and displayed on the cardholder's browser. The Payment data is collected on the browser and sent to Converge for processing. The response is sent back to the browser and appropriate action taken.

6. **License Code** - This value is provided by Converge and should be sent with each transaction.

7. **Save for Later Use Message** - Allows the merchant to define a message that is displayed to the user when they are trying to save a card for later use.
         
### Advanced Converge Payment Settings

:::::notice{note}

The fields in this section are not configurable and are populated by Converge.
:::::

1. **Merchant Name** - Trading as, operating as, doing business as, or assumed name, which may be different than the legal name. Based on value for the Processor Account ID.

2. **Region** - This field is used to limit the selection for other options, such as language.

3. **Currency** - This field determines the currency used to display prices.

4. **Payment Types Accepted** - Displays the available options for the selected terminal. The possible values are: Credit Card, ACH, Gift Card. The options are determined by the Payment action type and the response from the Converge Terminal. If the **Authorize** option is selected, all options except Credit Card are removed.

5. **Credit Cards Accepted** - Displays the available options for the selected terminal. The possible values are:
    - VISA
    - Master Card
    - American Express
    - Discover
    - JCB (Japan Credit Bureau)
    - CUP (China UnionPay)

6. **Wallets enabled** - Displays the available options for the selected terminal. The possible values are:
    - PayPal
    - Apple Pay

7. **Currency Conversion** - Values for this option are loaded from Converge, displayed to the user and used only to show the possible features in the future. The possible values are Multi-Currency Conversion and Dynamic Currency Conversion.

8. **Language Translations** - A dropdown that displays language options for a selected region.

9. **Value Added Service** - Values for this option are loaded from Converge and displayed to the user based on terminal settings. The possible values are:
    - Tokenization - If the terminal allows tokenization, the customer will have the option to save cards for later use.
    - Level 3 data - This allows sending additional data with each transaction based on the data provided by the merchant. If Level 3 is enabled, the merchant has to provide the following fields: Commodity code and Unit of measure code (Products > Inventory).
    - 3D Secure - if this option is enabled for the terminal, the transactions will be authenticated using 3D Secure in case the card is enrolled for 3DS.

10. **Proxy settings** - If your system uses a proxy server to establish the connection between WooCommerce and Converge, set **API Uses Proxy** to “Yes” and complete the **Proxy Host** and **Proxy Port** fields.

### Currency setup

Based on terminal settings, the value for Currency from WooCommerce > Settings > Currency options should match the currency selected for your terminal.
      
## Customer view

Following is an overview of the most important features in the daily usage of the Converge Plugin.

:::::notice{important}

The transaction management between Converge and your shop isn't synchronized. Any action performed directly through Converge back office will not be synchronized with WooCommerce. To keep records in both places, you must initiate actions such as Capture, Delete, etc. from your WooCommerce back office only.

:::::

1. **Placing an order** 
To capture new **Authorization Only** transactions, the options should be set as follows:

  - **Enabled** = Yes
  - **Environment** = Sandbox (in case of test transaction)
  - **Merchant ID, API User ID, User PIN** = valid settings provided by Converge
  - **Payment action** = Authorize

**Authorization and Capture** transactions should have the following settings:

  - **Enabled** = Yes
  - **Environment** = Sandbox (in case of test transaction)
  - **Merchant ID, API User ID, User PIN** = valid settings provided by Converge
  - **Payment action** = Authorize and Capture

Payment procedure is similar for guest and logged in user. The only exception is that logged in users have the option to **save credit card for later use.**

To initiate actual payment via Converge, you will access the **Checkout** page from the WooCommerce store view. You can place the order after populating **Billing and Shipping Addresses** and select a Converge payment method.
  
2. **Payment via Lightbox** 
If Lightbox is selected in the configuration page, a pop-up will appear once you select the payment method and click **Place order.**

:::::notice{important}
If you close the pop-up for Lightbox, the payment will be canceled.
:::::

Based on other selections on the configuration page, the following options are available:

  - **Payment with credit card** where you provide: Credit Card Number, Expiration Date and Card Verification Number
  - **Payment with gift card** where you provide: Gift Card number and Expiration Date.
  - **Payment with Electronic Check (ACH)** where you provide: Bank Routing Number, Bank Account Number, Bank Account Type, First Name, Last Name, and agree to the displayed message.

**Note**
To customize the Converge Lightbox, please refer to the :magic-link[Converge User Guide]{id="lightbox"}.

If you continue with your payment, you'll need to enter the card information and click **Pay.** The payment will either be *Accepted* or *Declined.*

If the payment is declined, an error message is displayed and the user can opt to *Try Again* or *Cancel.*

When your payment is accepted by Converge, you are redirected to WooCommerce and a new order is created. You can find more information on how to see payment details and how to manage captured transactions in the :magic-link[Admin View]{id="woocommerce-installation-guide#admin-view"} section.

3. **Payment via Checkout.js** 

If Checkout.js is selected in the configuration page, you can enter payment details directly on the checkout page. Based on other selections on the configuration page, the following options are available:

  - **Payment with credit card** where you provide: Credit Card Number, Expiration Date and Card Verification Number
  - **Payment with gift card** where you provide: Gift Card number and Expiration Date.
  - **Payment with Electronic Check (ACH)** where you provide: Bank Routing Number, Bank Account Number, Bank Account Type, First Name, Last Name, and agree to the displayed message.

4. **Partial payment with gift card** 

The customer can pay for an order with two payment methods, gift card and credit card, in the event the order total is greater than the amount available on the gift card.

  1. On the checkout page, opt to use a gift card and enter the card number.
  2. Click **Apply.** A message displays indicating that the amount on the gift card is not enough to complete the payment, and that you should select a credit card in order to complete the payment ("$X will be applied. Remaining order total $Y. Select payment method below to complete your order"). 
  3. The only available option is credit card, which is selected by default.
  4. Opt to continue paying by credit card and place the order.

If there are no errors and the order is created, the payment information details from the order record will be displayed separately for each payment method (credit card and gift card) on both shopper and merchant views.

5. **Stored card**

- **Add card when creating a new order** - Authenticated users have an additional option to store their credit card for future payments without leaving the WooCommerce store.

  1. The user must have an active WooCommerce account and be logged in before reaching the checkout page.
  2. Once on the checkout page, the user can select the checkbox called **Save for later use.** Once you make a successful payment with this option selected, the card is saved in both Converge and WooCommerce.

To view cards stored in WooCommerce, navigate to: My Account -> Payment methods.

- **Add card via the option from shopper account** - A credit card can be saved by adding it directly in the Payment methods section.

  1. Select **Add payment method.**
  2. Enter your personal and card information and save.
  3. The card is saved in both WooCommerce and Converge.

- **Delete stored card** - Since there isn't synchronization between Converge and WooCommerce, it is a best practice to delete stored cards directly from WooCommerce. If the merchant deletes the card from Converge, the user will still see the card in WooCommerce with an option to delete it manually.

   1. To delete stored cards directly from WooCommerce, go to My Account -> Payment Methods.
  2. Find the applicable card and click **Delete.**
  3. The card will also be deleted from Converge.

- **Pay with stored card** - To initiate payment with a stored card, perform the same steps as when using a new card. You will have the option to select stored cards on the checkout page.
   
Once you click **Place Order,** an API call is sent to Converge. You'll receive an error message if the payment is declined, or a new order number if the payment is accepted.

6. **3D Secure**  

If 3DSecure is enabled within your plug-in configuration, a request is sent to ConvergeGateway to check that their card is enrolled in 3DSecure. If their card is not enrolled in 3Dsecure the authorization will be processed as usual. Data within the authorization message will notify ConvergeGateway that the check was performed and that the cardholder was not participating.

If the cardholder is participating, they will be redirected to their issuing bank’s Access Control Server (ACS). This is the page where the customer enters the passphrase associated with their card. The customer will be redirected to either the success or failure page, depending on whether the 3Dsecure outcome falls under the allowed scenarios. Once you click on continue, you will be redirected to WooCommerce. If the payment was successful, you will see the number of the new order.

7. **Wallets** 
If the terminal supports wallets, the list of available wallets will be displayed at checkout.

- **PayPal Checkout** - After selecting the PayPal Checkout option, you will be redirected to the login page. You can continue as a new or a registered customer. If you select the Pay with Debit or Credit card option, you can check out as a guest. If you continue as a logged in user, clicking **Log in** will take you to the page where you have the list of payment options.
   
After choosing a payment method, the new page will review the shipping details and the chosen payment option. Once you click **Continue,** you will be redirected to WooCommerce. If the payment was successful, you will see the number of the new order.

- **PayPal Credit** - After selecting the PayPal Credit option, you will be redirected to the login page. You can continue as a new or a registered customer. If you select the Create an account option, you can check out as a guest. If you continue as a logged in user, clicking **Log in** will take you to the page where you have the list of payment options.
   
Once you click **Continue,** you will be redirected to WooCommerce. If the payment was successful, you will see the number of the new order.

8. **View order details** 

After successful payment, order details can be seen by logging in to WooCommerce Store and navigating to **My Account -> Orders-> View.**

## Admin View

As a merchant, you will be able to perform additional actions on captured transactions directly from WooCommerce Admin page without opening Converge screens.

### Void

You should be able to Void a sale transaction if it is in the correct state.

1. Navigate to WooCommerce -> Orders.
2. Select the order you wish to void.
3. Clicking **Void** in WooCommerce voids the transaction in Converge. The status of the order in WooCommerce is “Canceled”.

### Capture (Convert to Sale)

The Capture action is limited to *Authorization only* transactions, as they have to be converted to *Sale.*

To convert *Authorization only* transactions to *Sale*:

1. Create the transaction
2. Get the order number
3. Open the order from WooCommerce Admin
4. Click **Capture Authorized Transaction**
 
### Manual Settle

The Merchant may use this option if they need to send a settled batch to Converge earlier than end of their business day.

1. Open the order.
2. From the **Order actions** droplist, select *Settle Capture Transaction.*  
3. The transaction moves to *Settled Batch* in Converge immediately and the status is updated in the order notes. This action can only be performed once, and it is only available on the day the transaction is captured.
   
### Refund

You can partially or fully refund a transaction if Converge allows it.

1. Navigate to WooCommerce -> Orders. Select the order you wish to refund.
2. Click **Refund.**
3. Specify the refund amount.
    - For a full refund, the amount should be equal to the “Total available to refund amount”. Add refund notes if desired and click **“Refund £X via Elavon Converge NA Gateway”.
    - For a partial refund, the amount should be smaller than the entire amount.
    - A note will be added to let you know that the refund has been processed. 
    - If the refund has been completed for the entire order, the order status will be automatically changed to *Refunded.*

### Manually adding an order

1. To add a new order, go to WooCommerce > Orders.
2. Click **Add New** at the top of the page.
3. Enter the details for the order. Save.
4. A link is generated and is used to pay for the order.

:::::notice{note}

This functionality is provided by WooCommerce. More details here: https://docs.woocommerce.com/document/managing-orders/. Then select **Manually Adding an Order** from the option list on the right.
:::::


WooCommerce Installation Guide

Alliance Offers

Data as a Service

Invitation to Apply

Bank Holidays

Card Activation

Card Controls

Challenge-Widget

Commercial Credit Cards

Commercial Statements

Credit Card Account Details

Credit Card Accounts Overview

Credit Card Alerts

Credit Card Application Status

Credit Card APRs

Credit Card Balance Transfers

Credit Card Disputes

Credit Card Payments

Credit Card Qualified Offers

Credit Card Statements

Credit Card Transactions

Data Sharing for Marketing Purposes

Digital Wallets

Incoming Webhooks

Make a Payment - Coming Soon

Rewards Accelerator

Rewards Automatic Redemption

Rewards: Balance Summary

Rewards: Dashboard

Rewards Redemption Accounts

Rewards Redemptions

Rewards Transactions: Earned and Redeemed

Travel Notifications

User Profile

3DSecure2

CheckoutJs

Commerce SDK

Converge

Disputes Management

Dynamic Currency Conversion

eBoarding

Elavon Cloud Payments Interface

Elavon Payment Gateway

Fusebox

Hosted Payment Page

In Person Payments on Opayo

Leads

Lightbox payment modal

Online Payments on Opayo

Opayo

Opayo Direct

Opayo Forms

Opayo Reporting API

Opayo Server

Opayo Shared API

Payment Method Gateway

Payments Core 365

Simplify

viaconex

XML API

Card as a Service API

Core Banking API

Money Movement API

Reference API

Access Online Transactions

Account Transfers

Account Validation

ACH Originations

Avvance Connect

Avvance Express

Avvance Flex

Bank Information

Card as a Service

Check Payables

Corporate Account Information

Corporate Account Information 3LO

Corporate Credit Cards

Corporate Onboarding

Corporate Statements

Custody

Data Toolbox

Data Toolbox - Accounts

Data Toolbox - Documents

Data Toolbox - Transactions

Debit Card Phone Number Lookup

Disbursements via Zelle®

U.S. Bank Flexible Capital Platform

Freight Payment Customer Profiles

Freight Payment Transactions

Instant payments

Investment Accounting

PaySmart

Payee Choice

Payee Token+

Personal Loans

Positive Pay

Push to Card

Receivables

RTP® - Real-Time Payments

Tokenized Payments

Treasury Builder

U.S. Bank FBO Account

Virtual Account Reporting

Virtual Card Payments

Voyager Accounts

Voyager Cards

Voyager Drivers

Voyager Transactions

Voyager Vehicles

Wire Transfers

Converge Overview

Getting Started

Transaction Types

Credit Card Transactions Overview

Sale - ccsale

Auth only - ccauthonly

Auth Only Increment - ccauthonly

Verification - ccverify

Balance inquiry - ccbalinquiry

Return - ccreturn

Void - ccvoid

Completion - cccomplete

Delete - ccdelete

Update tip - ccupdatetip

Signature - ccsignature

Add recurring - ccaddrecurring

Update recurring - ccupdaterecurring

Delete recurring - ccdeleterecurring

Submit recurring payment - ccrecurringsale

Add installment - ccaddinstall

Update installment - ccupdateinstall

Delete installment - ccdeleteinstall

Submit installment payment - ccinstallsale

Credit card force - ccforce

Credit Card Credit - cccredit

Merchant Hosted Card On File

Debit Card Transactions

Debit Card Transactions Overview

Purchase - dbpurchase

Return - dbreturn

Auth Only - dbauthonly

Auth only Increment - dbauthonly

Complete - dbcomplete

Reverse - dbreverse

Debit - dbvoid

Delete - dbdelete

Inquiry - dbbainquiry

PINless bill pay - pldbillpay

Pinless debit purchase - pldpurchase

BIN Lookup - binlookup

Straight Send

Cash Tender Transactions

Cash Tender Transactions Overview

Sale - cashsale

Credit - cashcredit

EMV Credit/Debit Card Transactions

EMV card transactions overview

Sale - emvchipsale

Auth Only - emvchipauthonly

Swipe sale - emvswipesale

Swipe auth only - emvswipeauthonly

Card update - emvchipupdatetxn

Reversal - emvreverse

Key exchange - emvkeyexchange

Legacy key exchange - caddbkeyexchange

Interac Refunds

Return - emvchipreturn

EMV DCC check - emvdcccheck

EBT Transactions

EBT transactions overview

Food stamp benefits

Purchase - fspurchase

Return - fsreturn

Inquiry - fsbainquiry

Force purchase - fsforcepurchase

Force return - fsforcereturn

Cash benefits

Purchase - cbpurchase

Inquiry - cbbainquiry

Gift Card Transactions

Gift Card Transactions Overview

Activation - egcactivation

Sale or Redemption - egcsale

Refund - egccardrefund

Replenishment or Reload - egcreload