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


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

<p>U.S. Bank Europe DAC. Registered in Ireland – Number 418442..  Registered Office: Block F1, Cherrywood Business Park, Dublin 18, D18 W2X7, Ireland.</p>
<p>U.S. Bank Europe DAC, trading as Elavon Merchant Services, is regulated by the Central Bank of Ireland.</p>
<p><br>
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.</p>
<p>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.</p>


Most popular solutions

Additional solutions

Fusebox integration & options

Optional platform features

Documentation

North America

Europe

Regions

Establish an adequate http timeout value to prepare for delays or connection issues. Elavon recommends setting the timeout value to 60 – 120 seconds.

## Step 1: Session token request

Request a session token :magic-link[/transaction_token]{id="api-reference#tag/Request-Session-Token"} using x-www-form-urlencoded key/value pairs. The session token response is only valid for 15 minutes and can only be used once. A session token will be returned.  

| Objects | Description |
|----------------|----------------------------------------|
| Credentials | API user credentials. :magic-link[Contact us]{id="overview#getting-started"} if you need your user credentials. <br>Required |
| Transaction type | The available :magic-link[payment types]{id="transaction-types"}<br>Required|
| Transaction amount | If no amount is provided your customer will be prompted to enter the amount |
| Payment token | See :magic-link[credit card tokens]{id="transaction-types#credit-card-tokens"} |
| Invoice number | This value is passed back to the card issuer and provided to the cardholder on their monthly statement to identify the transaction | 
| Address verification | The cardholder’s / customer’s billing address |
| Doing Business As | How information should appear on a customer's credit card statement. See :magic-link[DBA]{id="dba"}. |
| Language option | Lightbox integration supports the following language values in the `ssl_language` field:<ul><li>en = US English</li><li>fr = Canadian French</li><li>es_la = Spanish</li><li>pt_br = Portugese</li><li>de = German</li><li>zh_cn = Simplified Chinese</li><li>ja = Japanese</li><li>ko = Korean</li></ul> | 

## Step 2: Display Lightbox payment modal 

Once the session token is obtained, you should call the lightbox function `PayWithConverge.open` and pass the previously obtained session token as the `ssl_txn_auth_token` value. To avoid CORS errors, the token should not be pulled from the DOM and then passed. The request must come from a website URL that is registered with Converge. 

The following JavaScript libraries must be included in the head of your code: 

- **Demo site**:  `https://api.demo.convergepay.com/hosted-payments/PayWithConverge.js` 
- **Live site**:  `https://api.convergepay.com/hosted-payments/PayWithConverge.js` 

**Best Practices**
- Your credentials must be kept secure. Elavon strongly recommends passing and storing Converge credentials through server-side code instead of client-side code. 
- Always submit data to Converge through Hyper Text Transfer Protocol Secure (HTTPS) using the POST method. 
- Request parameters should be included in the body of the message.  Do not put request parameters in the request url.

 ## Lightbox sample code 
### HTML server-side code

```html
<html> 
<head> 
    <meta http-equiv="content-type" content="text/html; charset=UTF-8"> 
    <title>Lightbox Demo</title> 
    <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script> 
    <script src="https://demo.convergepay.com/hosted-payments/PayWithConverge.js"></script> 
 
    <script> 
        function initiateLightbox() { 
            var tokenRequest = { 
                ssl_first_name: document.getElementById('name').value, 
                ssl_last_name: document.getElementById('lastname').value, 
                ssl_amount: document.getElementById('ssl_amount').value 
            }; 
            $.post("lightboxccsale.php", tokenRequest, function (data) { 
                document.getElementById('token').value = data; 
                transactionToken = data; 
            }); 
            return false; 
        } 
        function showResult(status, msg) { 
            document.getElementById('txn_status').innerHTML = "<b>" + status + "</b>"; 
            document.getElementById('txn_response').innerHTML = msg; 
        } 
        function openLightbox() { 
            var paymentFields = { 
                ssl_txn_auth_token: document.getElementById("token").value 
            }; 
            var callback = { 
                onError: function (error) { 
                    showResult("error", error); 
                }, 
                onCancelled: function () { 
                    showResult("cancelled", ""); 
                }, 
                onDeclined: function (response) { 
                    showResult("declined", JSON.stringify(response, null, '\t')); 
                }, 
                onApproval: function (response) { 
                    showResult("approval", JSON.stringify(response, null, '\t')); 
                } 
            }; 
            PayWithConverge.open(paymentFields, callback); 
            return false; 
        } 
       function showResult(status, msg) { 
          document.getElementById('txn_status').innerHTML = "<b>" + status + "</b>"; 
          document.getElementById('txn_response').innerHTML = msg; 
      } 
    </script> 
</head> 

<body> 
    <form name="getSessionTokenForm"> 
        <br><br><br><br>       
        First Name: <input type="text" id="name" name="ssl_first_name" size="25" value="John"> <br><br> 
        Last Name: <input type="text" id="lastname" name="ssl_last_name" size="25" value="Smith"> <br> 
        Transaction Amount: <input type="text" id="ssl_amount" name="ssl_amount" value="100.00"> <br> <br> 
        <button onclick="return initiateLightbox();">Click to Confirm Order</button> <br> 
    </form> 
    <br><br> 
    Transaction Token: <input id="token" type="text" name="token"> <br /> 
  
    <button onclick="return openLightbox();">Proceed to Payment</button> <br> 
    </form> 
    <br><br><br><br> 
    Transaction Status:<div id="txn_status"></div> 
    <br> 
    Transaction Response:<div id="txn_response"></div> 
</body> 
</html>
```
### PHP client-side code (lightboxsale.php)

```php
<?php 
 
 // Set variables 
$merchantID = "xxxxxx"; //Converge 6 or 7-Digit Account ID *Not the 10-Digit Elavon Merchant ID* 
$merchantUserID = "convergeapi"; //Converge User ID *MUST FLAG AS HOSTED API USER IN CONVERGE UI* 
$merchantPinCode = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"; //Converge PIN (64 CHAR A/N) 
$vendorID = "xxxxxx"; //Vendor ID 

$url = "https://api.demo.convergepay.com/hosted-payments/transaction_token"; // URL to Converge demo session token server 
//$url = "https://api.convergepay.com/hosted-payments/transaction_token"; // URL to Converge production session token server 

/*Payment Field Variables*/ 
// In this section, we set variables to be captured by the PHP file and passed to Converge in the curl request. 
$firstname=$_POST['ssl_first_name']; //Post first name 
$lastname=$_POST['ssl_last_name']; //Post first name 
$amount= $_POST['ssl_amount']; //Post Tran Amount 
//$merchanttxnid = $_POST['ssl_merchant_txn_id']; //Capture user-defined ssl_merchant_txn_id as POST data 
//$invoicenumber = $_POST['ssl_invoice_number']; //Capture user-defined ssl_invoice_number as POST data 

//Follow the above pattern to add additional fields to be sent in curl request below. 

$ch = curl_init(); // initialize curl handle 
curl_setopt($ch, CURLOPT_URL,$url); // set url to post to 
curl_setopt($ch,CURLOPT_POST, true); // set POST method 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); 

// Set up the post fields. If you want to add custom fields, you will add them in Converge and add the field name in the curlopt_postfields string. 
curl_setopt($ch,CURLOPT_POSTFIELDS, 
"ssl_merchant_id=$merchantID". 
"&ssl_user_id=$merchantUserID". 
"&ssl_pin=$merchantPinCode". 
"&ssl_transaction_type=CCSALE". 
"&ssl_amount=$amount" 
// "&ssl_first_name=$firstname". 
// "&ssl_last_name=$lastname". 
// "&ssl_get_token=Y". 
// "&ssl_add_token=Y". 
);
 
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); 
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($ch, CURLOPT_VERBOSE, true); 

$sessiontoken = curl_exec($ch); // run the curl process 
curl_close($ch); // Close cURL 

echo $sessiontoken;  //shows the session token.
 
 ?>
```

Take a payment

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

API reference

Integration guide

Customize payment modal

Payment types

Transaction management

Additional options

Wallets

3D Secure 2

Doing Business As

Export scripts

Billing and invoicing / Hospitality

Authentication

Invoice lifecycle

Managing invoices

Status and error codes

Status codes

Error codes

Response codes

Test cards

Elavon domains and IP addresses

Release notes