Terminal Setup - terminalsetup

The terminalsetup transaction retrieves the terminal and merchant setup information.

In this section:

For the entire list of API endpoints, refer to API Endpoints.

Request

Field name	Description	Required	Length	Data type
`ssl_merchant_id`	Merchant ID Elavon-assigned Converge Account ID (AID).	Required	6 or 7	numeric
`ssl_user_id`	Converge User ID The user ID with Hosted Payment API User status that can send transaction requests through the terminal.	Required	15	alphanumeric
`ssl_pin`	Terminal ID Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway. 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 Value: `terminalsetup`	Required	20	alphanumeric

Response

Field name	Description
MerchantInformation	Merchant Information Container Contains the Merchant Information elements.
`MerchantName`
`Address1`	Address Line 1
`Address2`	Address Line 2
`City`	City’s Name
`StateProvice`	State Code/Province Code
`PostalCode`	ZIP or Postal Code
`ContactName`	Contact’s Name
`ContactPhone1`	Contact’s Primary Phone Number
`ContactPhone2`	Contact’s Alternate Phone Number 2
`ContactEmail`	Contact’s Email Address
`TerminalEmail`	Terminal’s Email Address
`SMSEmail`	Merchant’s Email Address
`MerchantURL`	URL Address
TerminalInformation	Terminal Information Container Contains the Terminal Information elements.
`vm_friendly_name`	Terminal Name As set up by Elavon.
`vm_region`	Region of Business
`vm_time_zone`	Time Zone
`vm_currency`	ISO Currency Code
`vm_market_segment`	Market Segment
`vm_status`	Terminal Status Examples: `ACTIVE`, `NOT LIVE`, or `SUSPENDED`
`vm_processing_type`	Processing Type Terminal-based Only
`vm_payment_types`	Payment Types Indicates if the terminal is set up (Y) or not set up (N) for these payment types: `Credit` - Credit Card `Debit` - Debit Card `Gift` - Gift Card `ECheck` - Electronic Check `FoodStamp` - Food Stamp Card `CashBenefit` - Cash Benefit Card `Cash` - Cash
`vm_card_brands`	Card Brand Indicator Indicates if the terminal is set up to accept payments from specific card brands. Valid values: `Y` - Set up to accept payment from card brand `N` - Not set up to accept payment from card brand
`vm_credit_option`	Credit Card Payment Option Indicator Indicates if the terminal is set up (Y) or not set up (N) for these credit card payment options: `AVS` - Address Verification Service `CVN` - Card Verification `Purchase Card` - Purchase Card `DCC` - Dynamic Currency Conversion `MCC` - Multi-Currency Conversion `Recurring` - Recurring `Last4digits` - Last 4 Digits `TravelData` - Travel Data `AccountUpater` - Account Updater
`vm_recurring_option`	Default Recurring Options Values: `Frequency` - Billing Cycle `Payments` - Number of Payments
`vm_debit_option`	Debit Card Payment Options Indicates the terminal’s default debit card payment setup: `Cashback` - Set up (Y) or not set up (N) for cashback `cashbackmaxamount` - Maximum Cashback Amount `Surcharge` - Set up (Y) or not set up (N) for surcharge `SurchargeAmount` - Surcharge Amount
`vm_echeck_option`	Electronic Check Options Indicates the terminal’s default electronic check setup: `CheckType` - Check Type ACHECHECK PAPERCHECK `TransactionType` - Check Transaction Option `ImageUploadOption` - Image Upload Option for Paper Check `Recurring` - Set up (Y) or not set up (N) for ACH Recurring
`vm_transaction_entry`	API Option Indicates the terminal’s default API setup: `EnableHTTPSTransaction` - Set up (Y) or not set up (N) for API `EnableHTTPSBatch` - Set up (Y) or not set up (N) for batch import API `EnableVMM` - Set up (Y) or not set up (N) for Converge Mobile
`vm_tokenization`	Tokenization Option Indicates if the terminal is set up (Y) or not set up (N) for tokenization.

Example

important

In this example, you will have to change the data values, such as my_merchant_id, my_user_id, my_pin, and transaction data to match your Converge account and meet the needs of your website.
Code samples provided are for demonstration only and should not be used for live transactions. All sensitive merchant data, including transaction amounts and your Converge credentials, should be placed in server side code.

Request

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>
  <ssl_transaction_type>terminalsetup</ssl_transaction_type>
</txn>

Response

<txn>
  <MerchantInformation>
    <MerchantName>ABC COMPANY</MerchantName>
    <Address1>123 MAIN STREET</Address1><Address2/>
    <City>ANY CITY</City>
    <StateProvince>GA</StateProvince>
    <PostalCode>999999</PostalCode>
    <ContactName/><ContactPhone1/><ContactPhone2/>
    <ContactEmail>email@elavon.com</ContactEmail>
    <TerminalEmail>email@elavon.com</TerminalEmail>
    <MerchantURL/>
  </MerchantInformation>
  <TerminalInformation>
    <vm_friendly_name>MY STORE</vm_friendly_name>
    <vm_region>USA</vm_region>
    <vm_time_zone>EST</vm_time_zone>
    <vm_currency>USD</vm_currency>
    <vm_market_segment>Retail</vm_market_segment>
    <vm_status>ACTIVE</vm_status>
    <vm_processing_type>TerminalBased</vm_processing_type>
    <vm_payment_types>
       <Credit>Y</Credit>
       <Debit>Y</Debit>
       <Gift>Y</Gift>
       <ECheck>Y</ECheck>
       <FoodStamp>Y</FoodStamp>
       <CashBenefit>Y</CashBenefit>
       <Cash>Y</Cash>
    </vm_payment_types>
    <vm_card_brands>
      <MasterCard>Y</MasterCard>
      <Visa>Y</Visa>
      <AmEx>Y</AmEx>
      <JCB>Y</JCB>
      <CUP>Y</CUP>
      <Discover>Y</Discover>
    </vm_card_brands>
    <vm_credit_option>
      <AVS>N</AVS><CVN>Y</CVN>
      <PurchaseCard>Y</PurchaseCard>
      <InvoiceNumber>Y</InvoiceNumber>
      <DCC>N</DCC><MCC>N</MCC>
      <Recurring>Y</Recurring>
      <Last4digits>N</Last4digits>
      <TravelData>N</TravelData>
      <AccountUpdater>Y</AccountUpdater>
    </vm_credit_option>
    <vm_level3>Y</vm_level3>
    <vm_recurring_option>
      <Frequency>MONTHLY</Frequency>
      <Payments>12</Payments>
    </vm_recurring_option>
    <vm_debit_option>
      <Cashback>Y</Cashback>
      <CashbackMaxAmount>100</CashbackMaxAmount>
      <Surcharge>Y</Surcharge>
      <SurchargeAmount>1.00</SurchargeAmount>
    </vm_debit_option>
    <vm_echeck_option>
       <CheckType>ACHECHECK</CheckType>
       <TransactionType>VERIFICATION</TransactionType>
       <Recurring>Y</Recurring>
    </vm_echeck_option>
    <vm_transaction_entry>
       <EnableHTTPSTransaction>Y</EnableHTTPSTransaction>
       <EnableHTTPSBatch>Y</EnableHTTPSBatch>
       <EnableVMM>Y</EnableVMM>
    </vm_transaction_entry>
    <vm_tokenization>Y</vm_tokenization>
  </TerminalInformation>
</txn>

Cash Advance

Apple Pay

Magento Guide

Terminal Setup - terminalsetup

Request

Response

Example

Request

Response