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

## Before You Start

### Recommended Knowledge

If you are not already familiar with [HTTP protocols](https://developer.mozilla.org/en-US/docs/Web/HTTP) protocols and [REST APIs](https://developer.mozilla.org/en-US/docs/Glossary/REST), take some time to familiarize yourself with them before you start working with billing and invoicing / hospitality.

### Set Up Your Development Environment

To get started, we recommend having the following software for working with the billing and invoicing / hospitality API.

- A REST API Client like [Postman](https://www.getpostman.com/) or client transfer protocol like [cURL](https://curl.haxx.se/)
- Your website must run on a webserver with the following specifications:
    - SHA-2 Certification
    - TLS 1.2 Enabled

## Get Started

### Configure Converge

To get started with billing and invoicing / hospitality, you will need to have the following pieces of information:

1. An account with Converge.
2. A Converge terminal set to the service segment.
3. Access to the Converge demo environment.
4. A consumer key and secret

### Get Converge Account from Admin

If you do not already have a Converge account ID for integrating with Converge API, contact your Converge account administrator and ask them to create an account in the converge Demo environment with API user permissions enabled. When your administrator finishes creating your account, you will receive an email with your consumer key and secret.

### Confirm Web UI Settings

The billing and invoicing / hospitality API requires several terminal pieces of information from the web UI and requires setting up invoicing and email templates. Refer to [set up Converge billing and invoicing](https://support.convergepay.com/s/article/Set-Up-Converge-Billing-and-Invoicing) for more information on these processes.

### Endpoint URLS

The billing and invoicing / hospitality API has a demo endpoint and a production endpoint available for use.

- **Demo**: `https://cert-api.elavon.com/ecomm/billing/v2`

This is the demo URL for testing the billing and invoicing / hospitality API integration. 

- **Production**: `https://api.elavon.com/ecomm/billing/v2`

This is the production URL for the billing and invoicing / hospitality API. Do not use this URL until your integration is ready to enter production.

### Next Steps

After you get access to the Converge demo environment, you can begin developing with the API.

For more information on the billing and invoicing / hospitality requests and responses, refer to the :magic-link[Billing and Invoicing / Hospitality API Reference]{id="billing-and-invoicing-api-reference"}.

## Authentication

To begin processing requests and receiving responses from the billing and invoicing / hospitality API, do the following: 
- Start a session with the API by posting an authentication request to the `https://{environment}.elavon.com/ecomm/billing/v2/token` endpoint. 
- After processing the request, the gateway will respond with a session token. 
- Include this token to validate further requests to the gateway.

::image{id="/content/dam/developer-portal-solutions/en-us/elavon/media/images/products/converge/authentication-flow.png" alt="Diagram explaining the authentication flow involving request from your application and response from Elavon Gateway"}

### Authentication Requirements

You will need two api keys to authenticate to the billing and invoicing / hospitality API.  

- Consumer key
- Secret

Elavon will provide these keys when you start your project. You will receive different versions of both keys for testing and production environments.

To authenticate, you'll need to concatenate your consumer key and secret and encode them as a base 64 string. You'll use this string as the value for the `authorization` header in requests to the `/token` endpoint. The following authentication URLs provide the token endpoint:

- **Test**: `https://cert-api.elavon.com/auth/oauth2/v1/`
- **Production**: `https://api.elavon.com/auth/oauth2/v1/`

For more information, refer to the :magic-link[billing and invoicing / hospitality  API reference]{id="billing-and-invoicing-api-reference"}.

Billing and Invoicing / Hospitality Getting Started

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

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

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

Balance inquiry - egcbalinquiry

Credit - egccredit