<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

Lightbox integration enables your eCommerce store to collect payments securely and is ideal for businesses that need a checkout page that:

- Links their custom-built website with the Converge payment gateway
- Allows Converge to handle card data and payment processing
- Is simple to implement and customer friendly
- Is Americans with Disabilities Act (ADA) compliant

**Lightbox** offers checkout/payment forms that are SAQ-A-compliant and that make collecting payment information from your customer easy, and without the payment data touching your server.

Lightbox uses an iframe to embed your checkout form as an overlay to your online store. When your online store calls the checkout form, your store darkens and becomes a transparent background, and the checkout form appears as a floating element.

To use Lightbox, your server must have the following settings:

- All pages that use the Converge Payment Script must be served over HTTPS.
- Your domain must have a valid SSL certificate.
- Your server must support TLS 1.2 protocol.
- The Referrer URL of the domain making the Lightbox call must be added to an "allowed" list.
- All pages that include Lightbox must import the Pay With Converge JavaScript Library.

## Payment and Transaction Types

Lightbox integration supports the following transaction types of each payment type:

- **Credit Card**
    - :magic-link[Sale - ccsale]{id="ccsale"}
   - :magic-link[Authorization Only - ccauthonly]{id="ccauth-only"}
   - :magic-link[Verification - ccverify]{id="ccverify"}
   - :magic-link[Get Token - ccgettoken]{id="ccgettoken"}

- **Electronic Check**
   - :magic-link[Sale - ecspurchase]{id="ecspurchase"}

- **Gift Card**
  - :magic-link[Sale - egcsale]{id="egcsale"}    

## Language Values

Lightbox integration supports the following language values in the `ssl_language` field:

- en = US English<br>
- fr = Canadian French<br>
- es_la = Spanish<br>
- pt_br = Portuguese<br>
- de = German<br>
- zh_cn = Simplified Chinese<br>
- ja = Japanese
- ko = Korean

## Integration

To integrate with the Converge payment gateway through Lightbox, your will need to complete the following:

1. Contact Software Technical Support Team or Customer Service.
2. Customize your Lightbox checkout form.
3. Develop the Payment Processing program.

### Contact Software Technical Support Team/Customer Service

To implement Hosted Payments integration, you will need to contact the Software Technical Support Team or Customer Service at 1-800-377-3962 | Option 2 | Option 2 to:

- Enable the merchant IP filter and add the IP address of the server making the session token request.
- Designate a Converge user ID with a Hosted Payment API User status in order to post a session token request.
- Associate the Converge user ID with the eCommerce terminal.
- Ensure the API user has user rights parallel to the transaction types you plan to use.
- Add the website domain of your website to the HTTP Referrer list.

### Customize the checkout form

To customize your Lightbox checkout form, complete these steps:

1. Log in to your Converge demo site.
2. Click **Home**. The **Client Accounts** page appears.
3. Search for the terminal that handles eCommerce transaction processing.
4. Select the terminal by clicking its name under the **Terminal Name** column. The **Settings** page appears.
5. Under **Advanced API Settings**, click **Hosted Payments**. The **Which solution is right for you** page appears.
6. Customize your Lightbox checkout form.<p>
    - Click the **SETUP** button for Hosted payment modal setup. The **Modal Setting** page appears.
    - Click the **Company** Logo upload button and select the image file of your business logo.
    - Select the color scheme from the **Theme** field.
    - Select the **Enable CAPTCHA** checkbox to include a challenge-response test to the form.
    - Click **Save**.

### Develop the Payment Processing program

The Payment Processing program that you will develop must include session token request function, and callback response handling function.

#### Session Token Request 

Your session token request function must include the following parameters:

| Field name | Description | Required | Length | Data type |
|--------|---------------------------------|-----------|------|-------------|
| `ssl_account_id`<br>(Formerly known as `ssl_merchant_id`)<br>**Note:**  `ssl_merchant_id` will be eventually removed from the developer portal but both the fields will be functional in the code. | Elavon-assigned Converge Account ID (AID) | Required | 15 | numeric |
| `ssl_user_id` | Converge User ID<br>The user ID with Hosted Payment API User status that can send transaction requests through the terminal. | Required | 15 | alphanumeric |
| `ssl_pin` | Terminal ID<br>Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.<br>**Important:** The `ssl_user_id` sending the transaction request must be associated with the terminal that will process the request. | Required | 64 | alphanumeric |
| `ssl_transaction_type` | Transaction Type | Required | 20 | alphanumeric |
| `ssl_amount` | Transaction Amount<br>Data entry depends on the `ssl_transaction_type` value.  | Conditional | 11 | numeric |
| `ssl_txn_auth_token` | Session Token Response | Required | 50 | alphanumeric |

The endpoints to POST the session token request to are as follows:

- **Demo Site:** `https://api.demo.convergepay.com/hosted-payments/transaction_token`
- **Live Site:** `https://api.convergepay.com/hosted-payments/transaction_token`

Your session token request function must be able to capture the Session Token Response from Converge.

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.

:::::notice{note}

The Session Token Response is only valid for 15 minutes and can only be used once.
:::::


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`

#### Call Back Response Handling 

Based on your hosted payments configuration, Converge can post the transaction response to your website. You can use the response to update our backend system and display the appropriate response to the customer.

## Sample PHP Code

The following is an example of how to handle initializing a lightbox session using 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)

 $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 would 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 procss
curl_close($ch); // Close cURL


echo $sessiontoken;  //shows the session token.


 ?>

```

You can test this code using the following HTML page.

```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("lightboxccsaledevportal.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>
```


Lightbox

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