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

XML API integration is ideal for businesses that want to:

- Completely control the checkout process.
- Directly integrate with Converge.
- Collect payment data using their own servers and pass that information to Converge for processing.

:::::notice{important}
In XML API, you must include system fields marked as required. In addition, you may pass custom created fields and any other fields you would like to be stored with the transaction. Example: `ssl_description`, `ssl_merchant_txn_id` or `ssl_invoice`
:::::

This list provides an overview of the XML API integration method:

- **Ease of Integration:** Hard
- **Service Provider PCI:** PCI Level 1
- **Merchant PCI DSS Self-Assessment Questionnaire (SAQ) Type:** SAQ D
- **Customization:** Extensive
- **Most Suited for These Market Segments:**
 - Retail
 - Restaurant/Service
 - Mail Order / Telephone Order
 - eCommerce
- **Most Applicable To These Transactions**
 - Card Present – Hand-Keyed Transactions
 - Card Present – Swiped Transactions
 - Card Present – EMV Transactions
 - Card Not Present – eCommerce Transactions
 - Card Not Present – Back Office/MOTO Transactions

:::::notice{note}
For card-present transactions, we strongly recommend reviewing the capabilities before starting a direct integration with Converge.
:::::


:::::notice{important}
**PCI requirements for Integrated Partners:**
- If a partner has access to payment card data, one is required to validate PCI compliance as a PCI Level 1 Service Provider annually. This requires the submission of a Report on Compliance (ROC) based on an on-site audit completed by a Qualified Security Assessor (QSA) before processing. 
- Subsequently, Card Brand registration is also required. PCI validation must be completed and documentation provided in order to execute the registration process with each card brand network annually.
:::::


**Demo Endpoint:**  `https://api.demo.convergepay.com/VirtualMerchantDemo/processxml.do`

**Production Endpoint:**  `https://api.convergepay.com/VirtualMerchant/processxml.do`

## Implementation Guidelines

Converge doesn't expect a fully validated XML document, but an XML-formatted request assigned to XML encoded variables called xmldata. Only the Converge-specific elements for the transaction itself are supported.

:::::notice{note}
Make sure you include xmldata= with all xml api requests to Converge.
:::::

Here is a valid example with which xmldata= is included with any API request. 

``` xml
xmldata=
<txn>
 <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
 <ssl_user_id>my_user_id</ssl_user_id>
 <ssl_pin>my_pin</ssl_pin>
 ....
</txn>
```

XML has a special set of characters that cannot be used in normal XML strings. Special characters must be XML encoded to avoid problems.

For example, this XML string is invalid:

``` xml
<ssl_company>A & B Company</ssl_company>
```

And this XML string is valid:

```xml
<ssl_company>A & B Company</ssl_company>
```

The following special characters should be XML encoded:

- Control characters (values 0x01 to 0x1f, and 0x7f)

- 8-bit ASCII values (values > 0x7f)

- Any of the following characters:
 
 - ' ' (space character)

 - '"' (double quote)

 - '#' (hash or pound)

 - '<' (less than)

 - '>' (greater than)

 - '\' (back slash)

 - '^' (circumflex)

 - '`' (backquote)

 - '{' (left squiggly bracket or brace)

 - '|' (vertical bar)

 - '}' (right squiggly bracket or brace)

XML API

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

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

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