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

The *Batch Import File*  is a properly formatted CSV or XML batch file of credit card transactions that is uploaded through the :magic-link[Batch Import]{id="ccimport"} (`ccimport`) transaction.

## CSV Format

The format of a CSV batch file is as follows:

- Header
 - First line of the file.
 - Contains all the field names.
 - Each field name is enclosed within double quotes and followed by a comma.
- Transaction Data
 - Starts after the header line.
 - Each transaction data is placed on a single line.
 - Each transaction data is enclosed within double quotes and followed by a comma.
 - The transaction data is placed in the same order of the field names.

You can download a :download-link[csv template]{id="/content/dam/developer-portal-solutions/en-us/elavon/media/files/products/converge/converge_batch_format_template.csv"} for batch imports.

**Example**
```CSV
"ssl_card_number","ssl_exp_date","ssl_amount","ssl_transaction_type",
"0000000000000000","1212","2.00","ccsale",
"0000000000000000","1213","5.00","ccforce",
```

## XML Format

The format of an XML batch file is as follows:

- The file contains a single `<txnimport>` element and multiple `<txn>` (transaction) nested elements.
- Every transaction is a set of XML tags.
- The number of `<txn>` corresponds to the number of transactions in the file.
- All elements must be closed in the order that these were opened.

**Example**

```XML
<txnimport>
 <txn>
 <ssl_card_number>0000000000000000</ssl_card_number>
 <ssl_exp_date>1212</ssl_exp_date>
 <ssl_amount>2.00</ssl_amount>
 <ssl_transaction_type>ccsale</ssl_transaction_type>
 </txn>
 <txn>
 <ssl_card_number>0000000000000000</ssl_card_number>
 <ssl_exp_date>1213</ssl_exp_date>
 <ssl_amount>5.00</ssl_amount>
 <ssl_transaction_type>ccforce</ssl_transaction_type>
 </txn>
</txnimport>
```

## Fields

:::::notice{note}

- A single file can have a mix of tokens and card numbers.
- You must provide either the card number (`ssl_card_number`) or the token (`ssl_token`) from a previously tokenized card number in each record.
- CVV2/CVC/CID values and Track data should never be stored, and therefore cannot be passed to Converge on the file.
:::::


| Field name | Description | Required | Length | Data type |
|--------|---------------------------------|-----------|------|-------------|
| `ssl_card_number` | Card Number Card Number as it appears on the credit card. | Conditional | 18 | numeric |
| `ssl_exp_date` | Card's Expiry Date Date when the card becomes invalid. **Important:** Required if `ssl_card_number` is not null. **Format:** MMYY | Conditional | 4 | numeric |
| `ssl_token` | Credit Card Token Encrypted card data that can replace `ssl_card_number`. **Important:** - The token must already be stored in Card Manager. - Use only if the terminal is set up with the *Tokenization* terminal option. | Conditional | 20 | alphanumeric |
| `ssl_amount` | Transaction Amount **Format:** Number with 2 decimal places | Required | 11 | numeric |
| `ssl_transaction_type` | Transaction Type **Valid values:**  `ccsale` (Sale), `ccauthonly` (Auth Only), `ccverify` (Verification), `ccforce` (Force) | Required | 20 | alphanumeric |
| [**Optional Fields**] | | | | |
| `ssl_invoice_number` | Invoice/Ticket Number Unique identifier of the invoice or ticket. | Optional | 25 | alphanumeric |
| `ssl_first_name` | First Name First name on the cardholder's / customer's account or billing address. | Optional | 50 | alphanumeric |
| `ssl_last_name` | Last Name Last name on the cardholder's / customer's account or billing address. | Optional | 50 | alphanumeric |
| `ssl_company` | Company Name Company name on the cardholder's / customer's account or billing address. | Optional | 50 | alphanumeric |
| `ssl_avs_address` | Address Line 1 Commonly the house number and street name on the cardholder's / customer's account or billing address. | Optional | 30 | alphanumeric |
| `ssl_address2` | Address Line 2 Apartment or condominium unit number and floor number on the cardholder's or customer's account or billing address. | Optional | 30 | alphanumeric |
| `ssl_city` | City City name on the cardholder's / customer's account or billing address. | Optional | 30 | alphanumeric |
| `ssl_state` | State Code State or province code on the cardholder's / customer's account or billing address. | Optional | 2 | alphanumeric |
| `ssl_avs_zip` | Postal or ZIP Code Postal or ZIP code on the cardholder's / customer's account or billing address. | Optional | 9 | alphanumeric |
| `ssl_country` | Country ISO Code Country ISO code on the cardholder's / customer's account or billing address. | Optional | 3 | alphanumeric |
| `ssl_phone` | Phone Phone number on the cardholder's / customer's account or billing address. **Important:** Accepts dashes. | Optional | 20 | numeric |
| `ssl_email` | Email Address The cardholder's or customer's email address. | Optional | 100 | alphanumeric |
| `ssl_ship_to_first_name` | Ship To First Name First name of the recipient on the shipping address. | Optional | 50 | alphanumeric |
| `ssl_ship_to_last_name` | Ship To Last Name Last name of the recipient on the shipping address. | Optional | 50 | alphanumeric |
| `ssl_ship_to_company` | Ship To Company Name Name of the company (recipient) on the shipping address. | Optional | 50 | alphanumeric |
| `ssl_ship_to_address1` | Ship To Address Line 1 House number and street name on the shipping address. | Optional | 30 | alphanumeric |
| `ssl_ship_to_address2` | Ship To Address Line 2 Apartment or condominium unit number and floor number on the shipping address. | Optional | 30 | alphanumeric |
| `ssl_ship_to_city` | Ship To City Name of the city on the shipping address. | Optional | 30 | alphanumeric |
| `ssl_ship_to_state` | Ship To State Code State code on the shipping address. | Optional | 2 | alphanumeric |
| `ssl_ship_to_zip` | Ship To ZIP Code Postal or ZIP code on the shipping address. | Optional | 9 | alphanumeric |
| `ssl_ship_to_country` | Ship To Country Country ISO code on the shipping address. | Optional | 3 | alphanumeric |
| `ssl_ship_to_phone` | Ship To Phone Phone number on the shipping address. | Optional | 10 | numeric |
| `ssl_bin_override` | Override Bank Identification Number (BIN) Allows the integrated application to pass the `ssl_Customer_code` and/or `ssl_salestax` values for non-corporate cards. **Valid value:**  `1` - Pass customer code and/or sales tax for non-corporate card transaction requests | Optional | 1 | numeric |
| `ssl_description` | Merchant-defined Transaction Description Short and custom text to describe the transaction. | Optional | 255 | alphanumeric |
| `ssl_customer_code` | Customer Code or Purchase Order Number Customer ID or PO number specified in the billing statement of the cardholder. | Optional | 17 | alphanumeric |
| `ssl_salestax` | Sales Tax Tax amount to add to the purchase or sales amount. For a tax exempt transaction, enter **0.00**. **Format:** Amount with 2 decimal places. | Optional | 8 | alphanumeric |
| `ssl_get_token` | Generate Token Indicator Indicates whether to generate a token when submitting the card data. **Valid values:**<ul><li> `Y` - Generate token</li><li> `N` - Do not generate token (Default)</li></ul> | Optional | 1 | alphanumeric |
| `ssl_approval_code` | Transaction Approval Code Unique code returned by the credit card processor that indicates the approval status of the transaction. Required if `ssl_transaction_type` = ccforce. | Conditional | 6 | numeric |
| `ssl_transaction_currency` | Transaction Currency The currency ISO code that the merchant applies to their goods or services. **Default:** USD or CAD Use only on terminals that are set up with the *Multi Currency* credit card payment option. | Optional | 3 | alphanumeric |
| `ssl_do_customer_email` | Send email to customer indicator. Indicates whether to send emails to customers when transactions are approved or declined. **Default value**: Set in terminal-Email form **Valid value:**<ul><li>`T` - Send email to customer. Defaults to **T** if the customer's email address is present in the original transaction and `ssl_do_customer_email` is null.</li><li>`F` - Do not send email to customer</li></ul> | Optional | 1 | alphanumeric |
| `Custom Fields` | User-defined Fields Up to 25 custom fields can be passed in the batch file. The fields entered in the file must match those specified in **Terminal Setup**, **Merchant**, **Payment Fields**, **Add New Field**. | Optional | - | - |

Batch Import File Format

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

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