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

## Get a Test Account

If you would like to access the test environment for the Converge API, contact Elavon product support and request credentials for the Converge test environment.

## Support

If you are an existing Elavon customer looking for help with your Converge setup, please contact the Converge helpdesk through any of the following:
- Email:
 - **Europe**: <convergehelpdesk@elavon.com>
 - **North America**: <custsvc@elavon.com>
- Telephone:
 - **United Kingdom**: 0345 604 2329 (Monday to Friday, 9:00 to 17:00 GMT)
 - **Ireland**: 0818 924 177 (Monday to Friday, 9:00 to 17:00 GMT)
 - **Poland**: (+48) 22 3065894 (Monday to Friday, 10:00-18:00 CET/CEST)
 - **USA**: +1 800 377 3962 (24/7)

## Status Site

Converge outages, scheduled maintenances, and potential authorisation issues are monitored at the [Elavon EU status site](https://status.elavon.eu/). You can subscribe to the *Converge E-commerce Gateway* component of the status site to be immediately notified of any incidents through email. You can opt out of the email notifications and visit the status site instead to check for any issues.

If you are experiencing any issues, go to <https://status.elavon.eu/>. The status site displays any known issues at the top banner and under the *Converge E-commerce Gateway* component. An expected resolution time will also be noted.

## Onboarding

Every integration begins with onboarding. If you're not a customer yet but are interested in learning more about our solutions, fill out our [onboarding form](https://www.elavon.co.uk/contact-us/sales-enquiry.html) to schedule your kick-off call.

## Hosted Payments Page Developer Guide

This guide is going to take you through the individual steps you'll need to take to start transacting with Converge. First, you'll need a Converge account and the following pieces of information:

- Merchant Alias
- Public Key
- Secret Key

These are provided by your account representative at onboarding. If you don't have these pieces of information or have lost them, you will need to contact support.

Be careful where you put your Secret Key. Do not under any circumstances include it as part of customer-facing code or upload it to a version control repository that is not private and tightly controlled. If you lose control of your Secret Key, [contact support](mailto:convergehelpdesk@elavon.com).

### Your First Request

Let's start by sending a simple request to Converge to make sure that everything is working correctly.

We're going to send one to the /orders endpoint because it is simple. The /orders endpoint doesn't expect much info and will respond with a list of Orders objects that exist on your account currently. For more information, see the :magic-link[Orders resource]{id="converge-api-reference#tag/Orders"}.

#### Authentication

Converge uses a basic authentication model that you can find by concatenating together your Merchant Alias and Secret Key and encoding it in Base 64.
You can make this request with any HTTP client. We're going to use cURL for our examples because it's everywhere and works for almost everyone, but feel free to use another one if you have it.

```curl
curl -X GET \ 
https://uat.api.converge.eu.elavonaws.com/orders \
 -H 'Accept: application/json;charset=UTF-8' \
 -H 'Accept-Version: 1' \
 -H 'Authorization: Basic {{Your Authentication Key}}' \
 -H 'Content-Type: application/x-www-form-urlencoded' \
 -H 'cache-control: no-cache'
```

If everything works correctly, you should get a response from the gateway that looks something like the following JSON.

```json
{
 "href": "https://api.eu.convergepay.com/orders/6xxFwvM8BqmM6T6DcF3DyTB3",
 "first": "https://api.eu.convergepay.com/orders?limit=10",
 "next": "https://api.eu.convergepay.com/orders?pageToken=MCwz&limit=10",
 "pageToken": "string",
 "nextPageToken": "MCwz",
 "limit": 10,
 "size": 10,
 "items": [ { ... } ] 
}
```

Even if your response doesn't have any actual order objects in it, as long as you receive a status code of 200, everything is fine.

### Next Steps

With all that out of the way, you're ready to start the real work of integrating with Converge.

#### Pick an Integration Method

Integration options let you decide the overall approach you would like your site to take to communicate. The approach you pick can affect how much data you collect and how you retain it. This starts to have implications for PCI compliance and GDPR regulations, which go well outside the scope of a quickstart guide. For more information on each option, read through the Integration Guides for each.

- **Hosted Payments Page** - This is great if you want a quick and easy integration.
- **Shopping Cart Plugins** - These work well if you have a content management system that works with one of the available plugins or if you would like to use an e-commerce framework like Magento on your website.
- **eCommerce API Integration** - This gives you full control over what data is retained, what is passed between servers, and how your transactions appear in Converge.

#### Understand the API

Each of the Integration Methods uses the REST API. Refer to the :magic-link[API Reference]{id="converge-api-reference"} to learn more about each of the endpoints, methods, and objects available to work with.

## eCommerce API Overview

Converge's full API integration is ideal for businesses that want to control every step of the transaction process or want to retain customer information on their own servers. Performing a full integration only requires ensuring that your server complies with the payment card industry self-assessment form and the General Data Privacy regulations.

Apart from those requirements, the integration can be performed using the endpoints described in the :magic-link[API Reference]{id="converge-api-reference"}.

## 3D Secure

Full API Integrators with Converge can secure their transactions and reduce their risk of fraud by using the Elavon 3D Secure 2 API. For more information on adding 3D Secure into your integration, refer to the 3DS Integration Guide on our global developer portal.

Converge General Quickstart

Alliance Offers

Data as a Service

Invitation to Apply

Accounts

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

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

Avvance

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

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

Incoming Webhooks

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

Overview

Getting Started

Converge User Roles

Converge Accounts

Requesting a Demo Merchant Account

Multi-Factor Authentication

Using the Expand Query Parameter

Pull and Push Notifications

API Reference

Common Use Cases

Online Transactions

One-off Payment

Pay with Stored Card/Shopper

Void Transaction

Refund Transaction

Create BLIK Transaction

Payment Links

Create Payment Link

Cancel Payment Link

Recurring Payments

Create Plan and Subscription

Lock and Unlock Plan

Delete Plan

Change Subscription Email Settings

Change End Date or Cancel Subscription

Wallet Management

How Can Integrators Manage Their Own Wallet

Create Scheduled Payments with the Same Amount

Create Scheduled Payments with Variable Amounts

Create Cardholder-Initiated Transaction from Card on File

Create Merchant-Initiated Transaction from Card on File

Apple Pay Integration

Google Pay Integration

Error Codes

Hosted Payments

Hosted Payments Overview

In - App Set Up

Server Configuration

Serverside Scripting

Hosted Payments Lightbox

Hosted Payments Redirect

Hosted Cards

Stored Shoppers and Stored Cards

Shopping Cart Plugins

Magento 2

Magento 2 Overview

Preparation

New Installation

Back Office Configuration

Shopper View

Merchant View

Customer View

OpenCart

OpenCart Overview

Upgrade from a Previous Version

WooCommerce

WooCommerce Overview

Subscriptions

Known Issues

Others

Testing

FAQs

Converge Release Notes

Support