Supported Transaction Input Fields

ssl_3dsecure_value

  • Description: Cardholder Authentication Verification (CAVV) (Visa). Universal Cardholder Authentication Field (UCAF) (MasterCard) validates the integrity of the Verified by Visa (VbV) transaction data.
  • Length: 80
  • Data Type: Base64 Encoded

ssl_3ds_message_version

  • Description: Message Version
  • Length: 20
  • Data Type: alphanumeric

ssl_3ds_server_trans_id

  • Description: 3DS Server Transaction ID
  • Length: 50
  • Data Type: alphanumeric

ssl_3ds_trans_status

  • Description: Transaction Status
  • Length: 1
  • Data Type: alphanumeric

ssl_3ds_trans_status_reason

  • Description: Transaction Status Reason
  • Length: 20
  • Data Type: alphanumeric

ssl_aba_number

  • Description: Routing or Transit Number. Unique code assigned to the bank to be able to send and receive funds from other financial institutions. Required for ACH ECheck transactions
  • Length: 9
  • Data Type: alphanumeric

ssl_account_type

  • Description: Bank Deposit Account Type.
  • Valid values:
    • 0 - Checking
    • 1 - Saving
  • Length: 1
  • Data Type: numeric

ssl_add_token

  • Description: Add to Card Manager Indicator. Indicates whether to generate and store the token in Card Manager. Important: Only applicable to terminals that are set up with the Tokenization  terminal option.
  • Valid values:
    • Y - Generate and store token
    • N - Do not store token (Default)
  • Length: 1
  • Data Type: alphanumeric

ssl_address2

  • Description: Address Line 2. Apartment or condominium unit number and floor number on the cardholder’s or customer’s account or billing address.
  • Length: 30
  • Data Type: alphanumeric

ssl_agree

  • Description: Agreement Indicator. Required for ACH ECheck transactions.
  • Valid values:
    • 0 - Does not agree
    • 1 - Agrees
  • Length: 1
  • Data Type: numeric

ssl_amount

  • Description: Transaction Amount. Amount sent for authorization, approval or refund. Important: When submitting transaction amounts to terminals that are set up with the Multi Currency credit payment option, make sure that the number of decimal places are correct as some currencies have 0 (like JPY) or 3 (like BHD) decimal places. Format: Number with 2 decimals places.
  • Length: 11
  • Data Type: numeric

ssl_applepay_billing

  • Description: Billing Address. The billing address in the cardholder’s Apple Pay account.
  • Length: 4000
  • Data Type: alphanumeric

ssl_applepay_shipping

  • Description: Shipping Address. The shipping address in the cardholder’s Apple Pay account.
  • Length: 4000
  • Data Type: alphanumeric

ssl_applepay_web

  • Description:
  • Length: 4000
  • Data Type:

ssl_approval_code

  • Description: Transaction Approval Code. Unique code returned by the credit card processor that indicates the approval status of the transaction.
  • Length: 6
  • Data Type: numeric

ssl_avs_address

  • Description: Address Line 1. Address Verification Service (AVS) data compared with the address on the card issuer’s file. Commonly the house number and street name on the cardholder’s / customer’s account or billing address. Recommended for hand-keyed transactions to qualify for better interchange rates.
  • Length: 30
  • Data Type: alphanumeric

ssl_avs_zip

  • Description: Postal or ZIP Code. Address Verification Service (AVS) data compared with the postal or ZIP code on the card issuer’s file. Recommended for hand-keyed transactions to qualify for better interchange rates.
  • Length: 9
  • Data Type: alphanumeric

ssl_background_color

  • Description: Payment Form Background Color. HTML hexadecimal code of the body’s background color. Default value - Set in terminal: Payment Form, Payment Form Setup, Payment Form Color, Body Background.
  • Length: 20
  • Data Type: alphanumeric

ssl_bank_account_number

  • Description: Bank Account Number. Unique identifier of the checking account. Only applicable to ACH ECheck transactions.
  • Length: 16
  • Data Type: numeric

ssl_bank_account_type

  • Description: Bank Account Type. Indicates the type of checking account. Required for ACH ECheck transactions.
  • Valid values:
    • 0 - Personal
    • 1 - Business
  • Length: 1
  • Data Type: numeric

ssl_bill_on_half

  • Description: Half of the Month or Semimonthly Indicator. Indicates when to process recurring or installment payment transactions if ssl_billing_cycle = SEMIMONTHLY.
  • Valid values:
    • 1 - 1st and 15th of the month
    • 2 - 15th and last day of the month
  • Length: 1
  • Data Type: numeric

ssl_billing_cycle

  • Description: Billing Cycle
  • Valid values:  DAILYWEEKLYBIWEEKLYSEMIMONTHLYMONTHLYBIMONTHLYQUARTERLYSEMESTERSEMIANNUALLYANNUALLYSUSPENDED
  • Length: 12
  • Data Type: alphanumeric

ssl_bin_override

  • Description: 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.
  • Length: 1
  • Data Type: numeric

ssl_card_number

  • Description: Card Number. Unique card identification number. Card length:
    • 18 - Gift Card
    • 19 - Credit Card
  • Length: 18 or 19
  • Data Type: numeric

ssl_callback_url

  • Description: Callback URL. The URL of the merchant that will host the response.
  • Length: 200
  • Data Type: alphanumeric

ssl_card_present

  • Description: Card Present Indicator. Indicates whether the card is physically present during the transaction. Recommended for hand-keyed transactions.
  • Valid values:
    • Y - Card present
    • N - Card not present
  • Length: 1
  • Data Type: alphanumeric

ssl_card_suffix

  • Description: Last 4 Digits
  • Length: 4
  • Data Type: numeric

ssl_card_type

  • Description: Card Type. Payment method to use for the transaction.
  • Valid values:  CREDITCARDDEBITCARDFOODSTAMPCASHBENEFITELECTRONICCHECKGIFTCARDLOYALTYCASH
  • Length: 10
  • Data Type: alphanumeric

ssl_cardholder_ip

  • Description: Cardholder IP Address
  • Length: 40
  • Data Type: alphanumeric

ssl_cardholder_tip_amount

  • Description: Tip or Gratuity Amount. Amount to add or update when Converge processes the original transaction as a Dynamic Currency Conversion (DCC) transaction and that the authorized amount is in the cardholder’s currency. To reset or remove the original tip amount from a DCC transaction, set the value to 0.00. Important: Only applicable to terminals set up for the Service market segment and with the Dynamic Currency credit payment option. Format: Number with 2 decimal places.
  • Length: 11
  • Data Type: numeric

ssl_cashback_amount

  • Description: Cashback Amount. Amount to pay the cardholder for making a debit purchase transaction. Important: Only applicable to terminals that are set up with the Cashback debit payment option. Format: Number with 2 decimal places.
  • Length: 12
  • Data Type: numeric

ssl_check_image

  • Description: Check Image. Scanned and encoded image of the check. Only applicable to ECS Paper Check Conversion transactions.
  • Length: BLOB
  • Data Type: Base64 Encoded TIFF

ssl_check_number

  • Description: Check Number. Unique identifier commonly printed at the bottom of the check.Only applicable to ACH ECheck transactions.
  • Length: 16
  • Data Type: numeric

ssl_city

  • Description: City. City name on the cardholder’s / customer’s account or billing address.
  • Length: 30
  • Data Type: alphanumeric

ssl_client_api_platform

  • Description: Transaction Source Platform. Operating system of the transaction source.
  • Length: 50
  • Data Type: alphanumeric

ssl_client_api_platform_version

  • Description: Transaction Source Platform Version. Version of the transaction source’s operating system.
  • Length: 50
  • Data Type: alphanumeric

ssl_client_api_source

  • Description: Transaction Source. Name of the application from which the transaction originates.
  • Length: 50
  • Data Type: alphanumeric

ssl_client_api_source_version

  • Description: Transaction Source Version. Version of the transaction source.
  • Length: 50
  • Data Type: alphanumeric

ssl_company

  • Description: Company Name. Company name on the cardholder’s / customer’s account or billing address.
  • Length: 50
  • Data Type: alphanumeric

ssl_clinic_other_amount

  • Description: Clinic/Other Amount. Amount of expenditures for clinic or other medical office services. Defaults to 0.00 if not sent. This field is only available on terminals with Healthcare enabled.
  • Length: NA
  • Data Type: numeric

ssl_completion_Date

  • Description: Travel Completion Date. Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking. Important: Only applicable to terminals that are set up with the Travel Data credit payment option. Format: MM/DD/YYYY.
  • Length: 10
  • Data Type: alphanumeric

ssl_country

  • Description: Country ISO Code. Country ISO code on the cardholder’s / customer’s account or billing address.
  • Length: 3
  • Data Type: alphanumeric

ssl_customer_code

  • Description: Customer Code or Purchase Order Number. Customer ID or PO number specified in the billing statement of the cardholder. Recommended for terminals that are set up with the Purchasing Card 2 credit payment option.
  • Length: 17
  • Data Type: alphanumeric

ssl_customer_id

  • Description: Customer ID. Merchant-defined unique customer identifier.
  • Length: 15
  • Data Type: alphanumeric

ssl_customer_number

  • Description: Customer/Payee Account Number. Customer or payee account number to submit in a PINless debit (pldpurchase) transaction.
  • Length: 25
  • Data Type: numeric

ssl_customer_vat_number

  • Description: Customer VAT Number. The identification number assigned by the VAT authority to the buying company. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 13
  • Data Type: alphanumeric

ssl_cvv2cvc2

  • Description: Card Verification Value / Card Validation Code. Card security code or number printed on the card and commonly used for card not present payment transactions. Required for eCommerce transactions.
  • Length: 4
  • Data Type: numeric

ssl_cvv2cvc2_indicator

  • Description: Card Verification Value / Card Validation Code Indicator. Indicates the status of the card security code or number during the transaction.
  • Valid values:
    • 0 - Bypassed
    • 1 - Present
    • 2 - Illegible
    • 9 - Not Present
  • Length: 1
  • Data Type: numeric

ssl_decline_offline

  • Description: Decline Transaction Indicator. Indicates the action for the EMV card or reader to take when terminals are offline.
  • Valid values:
    • Y - Chip card or reader declines transaction
    • N - Chip card or reader approves transaction
  • Length: 1
  • Data Type: alphanumeric

ssl_dental_amount

  • Description: Dental Amount. Amount of dental expenditures. Defaults to 0.00 if not sent. This field is only available on terminals with Healthcare enabled.
  • Length:
  • Data Type: numeric

ssl_departure_Date

  • Description: Travel Departure Date. Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking. Important: Only applicable to terminals that are set up with the Travel Data credit payment option. Format: MM/DD/YYYY.
  • Length: 10
  • Data Type: alphanumeric

ssl_description

  • Description: Merchant-defined Transaction Description. Short and custom text to describe the transaction.
  • Length: 255
  • Data Type: alphanumeric

ssl_dir_server_tran_id

  • Description: Direct Server Transaction Identification (ID)|
  • Length: 50
  • Data Type: alphanumeric

ssl_discount_amount

  • Description: Discount Amount. The discount amount for the entire transaction (order). Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 11
  • Data Type: numeric

ssl_do_customer_email

  • Description: Send Email to Customer Indicator. Indicates whether to send emails to customers when transactions are approved or declined. Default value - Set in terminal: E-mail Form.
  • Valid values:
    • 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.
    • F - Do not send email to customer
  • Length: Email Notification Setup
  • Data Type: Email Options

ssl_do_merchant_email

  • Description: Send Email to Merchant Indicator. Indicates whether to send emails to the merchant when transactions are approved or declined. Default value - Set in terminal: E-mail Form, Email Notification Setup, Email Options, Notify Merchant of Transaction Approval / Notify Merchant of Transaction Decline.
  • Valid values:
    • T - Send email to merchant. Defaults to T if ssl_do_merchant_email is null.
    • F - Do not send email to merchant
  • Length: 1
  • Data Type: alphanumeric

ssl_drivers_license_number

  • Description: Drivers License Number. Unique identification code as it appears on the license. Required for ECS Paper Check Conversion - Guarantee transactions.
  • Length: 16
  • Data Type: alphanumeric

ssl_drivers_license_phone_number

  • Description: Phone Number. Contact number (includes the area code) as it appears on the license. Required for ECS Paper Check Conversion - Guarantee transactions.
  • Length: 10
  • Data Type: numeric

ssl_drivers_license_state

  • Description: State Code. State code as it appears on the license. Required for ECS Paper Check Conversion - Guarantee transactions.
  • Length: 2
  • Data Type: alphanumeric

ssl_dukpt

  • Description: DUKPT. Value used to encrypt the PIN of the cardholder and returned by the PIN Pad.
  • Length: 20
  • Data Type: NA

ssl_duty_amount

  • Description: Duty Amount. The total charges for any import or export duties included in the transaction. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 11
  • Data Type: numeric

ssl_dynamic_dba

  • Description: Dynamic DBA. The dynamic doing business as name for this transaction. Allows a merchant to specify, on a per-transaction basis, wording that may be more recognizable or more service-specific to the customer than their usual business name. This can prevent chargebacks by preventing users from seeing transactions attached to unrelated names on their payment card statements.
  • Length: 21
  • Data Type: alphanumeric

ssl_dynamic_dba_address

  • Description: Dynamic DBA Address. This value allows a merchant use an alternate address for this transaction.
  • Length: 30
  • Data Type: alphanumeric

ssl_dynamic_dba_auth_type

  • Description: Merchant ID. The dynamic doing business as authorization type.
  • Valid values:
    • F - Final
    • P - Pre-authorize
  • Length: 1
  • Data Type: alphanumeric

ssl_dynamic_dba_city

  • Description: Dynamic City Name. The dynamic doing business as city name. This value allows a merchant use an alternate city as part of the address for this transaction
  • Length: 13
  • Data Type: alphanumeric

ssl_dynamic_dba_country

  • Description: Dynamic Country ISO Code. The dynamic doing business as International Standards Organization country code. This value allows a merchant specify an alternate country as part of the address for this transaction.
  • Length: 3
  • Data Type: alphanumeric

ssl_dynamic_dba_email

  • Description: Dynamic Email Address. The dynamic doing business as email address. This value allows a merchant specify an alternate email address for this transaction.
  • Length: 70
  • Data Type: alphanumeric

ssl_dynamic_dba_mcc

  • Description: Dynamic Merchant Category Code. The dynamic doing business as merchant category code. This value allows a merchant specify an alternate merchant category for this transaction.
  • Length: 22
  • Data Type: numeric

ssl_dynamic_dba_phone

  • Description: Dynamic Phone Number. The dynamic doing business as phone number. This value allows a merchant specify an alternate phone number for this transaction.
  • Length: 20
  • Data Type:alphanumeric

ssl_dynamic_dba_postal

  • Description: Dynamic Postal or ZIP Code. The dynamic doing business as postal code. This value allows a merchant set an alternate postal code for a transaction.
  • Length: 9
  • Data Type: alphanumeric

ssl_dynamic_dba_state

  • Description: Dynamic State Code. The dynamic doing business as state code. This value allows a merchant set an alternate state code for a transaction.
  • Length: 2
  • Data Type: alphanumeric

ssl_dynamic_dba_submid

  • Description: Dynamic Sub-merchant ID. The dynamic doing business as sub merchant ID. This value allows a merchant set an alternate sub-merchant ID for a transaction.
  • Length: 22
  • Data Type: numeric

ssl_dynamic_dba_taxid

  • Description: Dynamic Merchant Tax ID. The dynamic doing business as Merchant Tax ID. This value allows a merchant set an alternate Tax ID for this transaction.
  • Length: 14
  • Data Type: alphanumeric

ssl_eci_ind

  • Description: eCommerce Indicator
  • Valid values:
    • 5 - Fully authenticated (if eci = 01/1  or  05/5)
    • 6 - Attempted VbV (if eci = 02/2  or  06/6)
    • 7 - Not Authenticated (if eci = 03/3  or  07/7  or  not available)
  • Length: 1
  • Data Type: numeric

ssl_ecs_product_code

  • Description: ACH Processing Option. Overrides the default ACH type specified in Converge. Important:
    • WEB, TEL or PPD is required if ssl_bank_account_type = 0.
    • CCD is required if ssl_bank_account_type = 1.
  • Valid values:
    • WEB - Web-based Check Processing. For re-occurring or single Internet-initiated entry processed based on the customer’s input of account information at a payment application website
    • TEL - Telephone-based Check Processing. For re-occurring or single entry in which an Electronic Payment Item is created based on the customer’s verbal authorization that is captured through phone
    • PPD - Pre-arranged Payment and Deposit. For re-occurring or single pre-arranged payment entry to a customer’s account pursuant to a written authorization that is obtained from the customer
    • CCD - Corporate Credit or Debit. A debit entry is initiated by an organization to another organization.
  • Length: 3
  • Data Type: alphanumeric

ssl_egc_tender_type

  • Description: Tender Type. Tender type to use to pay for the gift card.
  • Valid values:
    • 0 - Cash
    • 1 - Credit Card
    • 2 - Debit Card
    • 3 - Check
  • Length: 1
  • Data Type: numeric

ssl_email

  • Description: Email Address. The cardholder’s or customer’s email address.
  • Length: 100
  • Data Type: alphanumeric

ssl_email_apprvl_footer_html

  • Description: Order Confirmation Email Footer - Approval. Footer text that appears in the order confirmation email of approved transactions. Default value - Set in terminal: E-mail Form, Email Notification Setup, Email Options Approval, Email Footer
  • Length: 255
  • Data Type: alphanumeric

sl_email_apprvl_header_html

  • Description: Order Confirmation Email Header - Approval. Header text that appears in the order confirmation email of approved transactions. Default value - Set in terminal: E-mail Form; Email Notification Setup; Email Options Approval; Email Header
  • Length: 255
  • Data Type: alphanumeric

ssl_email_decl_footer_html

  • Description: Order Confirmation Email Footer - Decline. Footer text that appears in the order confirmation email of declined transactions. Default value - Set in terminal: E-mail Form; Email Notification Setup; Email Options Decline; Email Footer
  • Length: 255
  • Data Type: alphanumeric

ssl_email_decl_header_html

  • Description: Order Confirmation Email Header - Decline. Header text that appears in the order confirmation email of declined transactions. Default value - Set in terminal: E-mail Form; Email Notification Setup; Email Options Decline; Email Header
  • Length: 255
  • Data Type: alphanumeric

ssl_email_footer

  • Description: Order Confirmation Email Footer. Footer text that appears in the order confirmation email of approved or declined transactions. If not null, overrides the ssl_email_apprvl_footer_html and ssl_email_decl_footer_html values.
  • Length: 255
  • Data Type: alphanumeric

ssl_email_header

  • Description: Order Confirmation Email Header. Header text that appears in the order confirmation email of approved or declined transactions. If not null, overrides the ssl_email_apprvl_header_html and ssl_email_decl_header_html values.
  • Length: 255
  • Data Type: alphanumeric

ssl_enc_loyalty_track_data

  • Description: Encrypted Track Data. Track data captured from the card’s magnetic stripe or an Ingenico encrypting device.
  • Length: 160
  • Data Type: alphanumeric

ssl_enc_track_data

  • Description: Encrypted Raw Track I and/or II Data. Encrypted Track I and/or II data captured from the card’s magnetic stripe or an Ingenico encrypting device. The data includes beginning and ending sentinels, card’s expiry date, cardholder’s first name, and the cardholder’s last name.
  • Length: 160
  • Data Type: alphanumeric

ssl_enc_track_data_format

  • Description: Encrypted Raw Track I and/or II Data Format. Format of the Track data captured from the card’s magnetic stripe. Required if card is read from a ROAM device.
  • Valid value:  ROAM_GENERIC_TDES_EMV
  • Length: NA
  • Data Type: NA

ssl_end_of_month

  • Description: End of Month Indicator. Indicates whether to process the recurring transaction on the last day of the month.
  • Valid values:
    • Y - Yes. Select Y to process the recurring transaction:
      • If ssl_billing_cycle = MONTHLY, BIMONTHLY, QUARTERLY, SEMESTER or SEMIANNUALLY and the Start Payment Date is April 30, June 30, September 30, November 30, February 28 (non-Leap year) or February 29 (Leap year).
      • If ssl_billing_cycle = ANNUALLY and the Start Payment Date is February 28 (non-Leap year) or February 29 (Leap year).
    • N - No
  • Length: 1
  • Data Type: alphanumeric

ssl_enrollment

  • Description: Enrollment Indicator. Indicates how to enroll in the loyalty program.
  • Valid values:
    • 00 - Enrolled
    • 01 - Enroll and link payment card
    • 02 - Enroll and link loyalty card and phone number
    • 03 - Enroll and link phone number only
    • 10 - Enrolled and link payment card
  • Length: 2
  • Data Type: numeric

ssl_entry_mode

  • Description: Transaction Entry Indicator. Indicates how the track data was captured.
  • Valid values:
    • 01 = Key entered - Card not present
    • 02 = Key entered - Card present
    • 12 = Key entered - Credential on file
    • 03 = Swiped (default)
    • 05 = EMV (ICC) with CVV or iCVV
    • 06 = EMV (ICC) proximity Read
    • 07 = EMV (ICC) without CVV or iCVV
    • 08 = EMV (ICC) - Mag stripe Read when the chip failed to read
  • Length: 2
  • Data Type: numeric

ssl_error_url

  • Description: Error URL. The URL where the integrated application will send the errorCode, errorName, and errorMessage values. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Error URL; URL
  • Length: 255
  • Data Type: alphanumeric

ssl_eWallet

  • Description: Wallet Identifier. Indicates the wallet payment type offered by the merchant.
  • Valid value:  MasterPass
  • Length: 10
  • Data Type: alphanumeric

ssl_eWallet_shipping

  • Description: Shipping Information Indicator. Indicates the shipping information to use for the wallet purchase.
  • Valid values:
    • Y - Use Click to Pay shipping information
    • N - Use shipping information from merchant’s website or payment form
  • Length: 1
  • Data Type: alphanumeric

ssl_exclude_account_update

  • Description: Exclude Account Update. Optional Field. A request with this field set to Y will not pass a token to the account updater.
  • Length: 1
  • Data Type: Boolean

ssl_exp_date

  • Description: Card’s Expiry Date. Date when the card becomes invalid. For credit card transactions that use tokens, do not send the expiry date when the token is stored in Card Manager. Format: MMYY
  • Length: 4
  • Data Type: numeric

ssl_first_name

  • Description: First Name. First name on the cardholder’s / customer’s account or billing address.
  • Length: 50
  • Data Type: alphanumeric

ssl_footer_html

  • Description: Payment Form Footer. Footer text that appears in the payment form. Default value - Set in terminal: Payment Form; Payment Form Setup; Payment Form Header/Footer; Payment Form Footer
  • Length: 255
  • Data Type: alphanumeric

ssl_freight_tax_amount

  • Description: VAT or Tax Amount. VAT or tax applied to the freight or shipping amount. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 12
  • Data Type: numeric

ssl_get_token

  • Description: Generate Token Indicator. Indicates whether to generate a token when submitting the card data. Only applicable to terminals that are set up with the Tokenization terminal option.
  • Valid values:
    • Y - Generate token
    • N - Do not generate token (Default)
  • Length: 1
  • Data Type: alphanumeric

ssl_header_color

  • Description: Payment Form Table Header Color. HTML hexadecimal code for the table header and border colors. Default value - Set in terminal: Payment Form; Payment Form Setup; Payment Form Color; Table Header and Border
  • Length: 20
  • Data Type: alphanumeric

ssl_header_html

  • Description: Payment Form Header. >Header text that appears in the payment form. Default value - Set in terminal: Payment Form; Payment Form Setup; Payment Form Header/Footer; Payment Form Header
  • Length: 255
  • Data Type: alphanumeric

ssl_healthcare_amount

  • Description: Healthcare Amount. Total amount in a healthcare transaction. Optional. ssl_healthcare_amount is equal to ssl_otc_amount + ssl_prescription_amount + ssl_clinic_other_amount + ssl_dental_amount. If this amount is not included in the transaction, then Converge will calculate based off of the other healthcare fields. If you do include this field in the transaction, then Converge will validate the field. If the validation fails, Converge will decline the transaction. This field is only available on terminals with Healthcare enabled.
  • Length: NA
  • Data Type: alphanumeric

ssl_icc_isr

  • Description: Issuer Script Results. Describes the results of the terminal script processing.
  • Length: 84
  • Data Type: alphanumeric

ssl_icc_tsi

  • Description: Transaction Status Information.
  • Valid values:
    • A - Accepted
    • E - Error Detected
  • Length: 1
  • Data Type: alphanumeric

ssl_image_type

  • Description: Signature Image Format. File format of the signature image. Required if ssl_signature_image is submitted.
  • Valid values:  GIF, TIF, JPG, PNG
  • Length: 3
  • Data Type: alphanumeric

ssl_import_file

  • Description: Import File. Describes the path, location, file name, and file extension of the import file. Important:
    • Length of the file name (including the file extension) must not exceed 30 characters.
    • Valid file extensions are CSV and XML.
  • Length: 255
  • Data Type: alphanumeric

ssl_include_signature

  • Description: Include Signature Indicator. Indicates whether to include transactions with signature images to the transaction query results.
  • Valid values:
    • TRUE - Include transactions with signature images
    • FALSE - Exclude transactions with signature images
  • Length: -
  • Data Type: alphanumeric

ssl_install_id

  • Description: Installment Record ID. Unique identifier of the installment record.
  • Length: NA
  • Data Type: NA

ssl_installment_id

  • Description: Installment ID. Unique identifier of the installment record.
  • Length: 50
  • Data Type: alphanumeric

ssl_invoice_number

  • Description: Invoice/Ticket Number. Unique identifier of the invoice or ticket. Required for eComm and MOTO transactions.
  • Length: 25
  • Data Type: alphanumeric

ssl_issue_points

  • Description: Accrue Points. Indicates whether to accrue points for the current transaction.
  • Valid values:
    • Y - Accrue points
    • N - Do not accrue points
  • Length: 1
  • Data Type: alphanumeric

ssl_key_pointer

  • Description: Triple-DES DUKPT Pointer. Indicates the encryption key used on US debit transactions.
  • Valid value:  T - Triple-DES DUKPT
  • Length: 1
  • Data Type: alphanumeric

ssl_ksn

  • Description: Key Serial Number. Unique identifier generated from the swiped payment card and returned by the encrypting device. The KSN encrypts the PAN data through the DUKPT method. Required if submitting ssl_enc_track_data, ssl_enc_track1_data or ssl_enc_track2_data in the transaction request.
  • Length: 20
  • Data Type: alphanumeric

ssl_last_name

  • Description: Last Name. Last name on the cardholder’s / customer’s account or billing address.
  • Length: 50
  • Data Type: alphanumeric

sl_level3_indicator

  • Description: Level 3 Indicator. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Valid values:
    • Y - Level 3 transaction (send Level 3 data to issuer)
    • N - Only save data locally (do not send Level 3 data to issuer)
  • Length: 1
  • Data Type: alphanumeric

ssl_line_Item_alternative_tax

  • Description: Alternate Tax ID. The alternate tax identifier description for the line item. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 12
  • Data Type: numeric

ssl_line_Item_commodity_code

  • Description: Line Item Commodity Code. The commodity code used to classify the line item. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 12
  • Data Type: alphanumeric

ssl_line_item_description

  • Description: Line Item Description. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 25
  • Data Type: alphanumeric

ssl_line_item_discount_amount

  • Description: Discount Amount. The discount amount for the entire line item. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 11
  • Data Type: numeric

ssl_line_Item_discount_indicator

  • Description: Line Item Discount Indicator. Indicates whether the line item is discounted. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
    • Y - Item amount is discounted
    • N - Item amount is not discounted
  • Length: 1
  • Data Type: alphanumeric

ssl_line_Item_extended_total

  • Description: Line Item Extended Amount. The total cost of the line item for the detail record. Computation Rule: Quantity x Unit Price. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 9
  • Data Type: numeric

ssl_line_Item_product_code

  • Description: Line Item Product Code. The part or catalog number of the line item. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 12
  • Data Type: alphanumeric

ssl_line_Item_quantity

  • Description: Line Item Quantity. The number of purchased units for the line item. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 12
  • Data Type: numeric

ssl_line_Item_unit_cost

  • Description: Line Item Unit Cost. The cost of each purchased unit for the line item. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 12
  • Data Type: numeric

ssl_line_Item_unit_of_measure

  • Description: Line Item Measurement Code. The unit of measure that each line item is purchased in. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 3
  • Data Type: alphanumeric

ssl_line_Item_tax_amount

  • Description: Line Item Tax Amount. The tax amount for each purchased unit. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 12
  • Data Type: numeric

ssl_line_Item_tax_indicator

  • Description: Line Item Tax Indicator. Indicates whether the line item is taxable. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
    • Y - Item amount is taxable
    • N - Item amount is not taxable
  • Length: 1
  • Data Type: alphanumeric

ssl_line_Item_tax_rate

  • Description: Line Item Tax Rate. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 4
  • Data Type: numeric

ssl_line_Item_tax_type

  • Description: Line Item Tax Type. The type of tax applied to the line item. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 4
  • Data Type: alphanumeric

ssl_line_Item_total

  • Description: Line Item Total Amount. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 12
  • Data Type: numeric

ssl_link_color

  • Description: Payment Form Hyperlinks Color. HTML hexadecimal code for the payment form’s hyperlinks color. Default value - Set in terminal: Payment Form; Payment Form Setup; Payment Form Color; Html Hyperlink Tags
  • Length: 20
  • Data Type: alphanumeric

ssl_loyalty_card_number

  • Description: Loyalty Card Number. Unique identifier of the loyalty card.
  • Length: 19
  • Data Type: numeric

ssl_loyalty_exp_date

  • Description: Loyalty Card’s Expiry Date. Date when the card becomes invalid. Format: MMYY.
  • Length: 4
  • Data Type: numeric

ssl_loyalty_track_data

  • Description: Loyalty Card Track Data. Track data captured from the card’s magnetic stripe.
  • Length: 76
  • Data Type: alphanumeric

ssl_mac_value

  • Description: Message Authentication Code. Authenticates that the Canadian debit message was not modified.
  • Length: 8
  • Data Type: hex

ssl_merchant_email

  • Description: Merchant’s Email Address. If null and ssl_do_merchant_email = T, Converge sends the order confirmation email to the email address of the terminal.
  • Length: 100
  • Data Type: alphanumeric

ssl_merchant_id

  • Description: Merchant ID. Elavon-assigned Converge Account ID (AID).
  • Length: 6 or 7
  • Data Type: numeric

ssl_merchant_initiated_unscheduled

  • Description: Merchant Initiated Unscheduled Transaction Indicator. Indicates the transaction was initiated by a merchant using a stored credential (token or stored card number) for a fixed or variable amount that does not occur on a scheduled or regularly occurring transaction date.
  • Valid values:
    • Y - Yes
    • N - No
  • Length: 1
  • Data Type: alphanumeric

ssl_merchant_txn_id

  • Description: Merchant Transaction ID. Unique transaction reference number sent to the downstream systems as part of the Encompass ROC data.
  • Length: 39
  • Data Type: alphanumeric

ssl_merchant_vat_number

  • Description: Merchant VAT Number. The identification number assigned by the taxing authority to the merchant. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 20
  • Data Type: alphanumeric

ssl_micr_data

  • Description: Unformatted Magnetic Ink Character Recognition Data. The exact MICR line from the check including the spaces and symbols. Replace the symbols with the following letters:
    • T - Transit symbol
    • O - On-US symbol
    • A - Amount symbol
    • D - Dash symbol
  • Length: 80
  • Data Type: alphanumeric

ssl_mobile_id

  • Description: Mobile Device ID. Unique identifier of the mobile device that sends the transaction request
  • Length: 40
  • Data Type: alphanumeric

ssl_mpos_acceptance_device

  • Description: Mobile Point of Sale Acceptance Device. This field indicates whether the device accepting payment information is a dedicated or off the shelf point of sale. Expected Values:
    • space = Not an MPOS Device
    • 0 = Dedicated mPOS Terminal with PCI compliant dongle (with or without key pad)
    • 1 = Off the shelf mobile Device (Phone, Tablet, etc.)
  • Length: 1
  • Data Type: alphanumeric

ssl_national_tax_indicator

  • Description: National Tax Indicator. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Valid values for Visa:
    • 0 - Tax not included in total purchase amount
    • 1 - Tax included in total purchase amount
  • Valid values for MasterCard:
    • Y - Tax included in total purchase amount
    • N - Transaction not subject to tax
    • 0 or Space - Tax information unknown
  • Length: 1
  • Data Type: alphanumeric

ssl_next_payment_date

  • Description: Next Payment Date. The date of the next scheduled payment for a recurring or installment transaction. Format: MM/DD/YYYY
  • Length: 10
  • Data Type: alphanumeric

ssl_oar_data

  • Description: OAR Data. This data will be as received during the original authorization processing. This is a “retain and return” value for terminal based settlement messages. You must store this field with the payment details from the transaction to make future Card On File transactions. You must include these fields in the transaction request, for all future Card On File transactions using Token or Card Number.
  • Length: 20
  • Data Type: alphanumeric

ssl_order_date

  • Description: Order Date. Date when the merchant received the order. Format: YYMMDD. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 6
  • Data Type: numeric

ssl_original_date

  • Description: Original Transaction Date. The date of the original Debit Purchase (dbpurchase) or Food Stamp Purchase (fspurchase) transaction. Format: MMDDYY
  • Length: 6
  • Data Type: numeric

ssl_original_time

  • Description: Original Transaction Time. The time of the original Debit Purchase (dbpurchase) or Food Stamp Purchase (fspurchase) transaction. Format: HHMMSS.
  • Length: 6
  • Data Type: numeric

ssl_otc_amount

  • Description: Over the Counter Amount. Amount of over the counter medical expenditures.Defaults to 0.00 if not sent. This field is only available on terminals with Healthcare enabled.
  • Length:
  • Data Type: numeric

ssl_other_fees

  • Description: Other Fees. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 12
  • Data Type: numeric

ssl_other_tax

  • Description: Other Tax Amount. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 12
  • Data Type: numeric

ssl_partial_auth_indicator

  • Description: Partial Authorization Indicator. Indicates whether the integrated application supports partial authorization or approval.
  • Valid values:
    • 0 - Partial authorization not supported (Default)
    • 1 - Partial authorization supported
  • Length: 1
  • Data Type: numeric

ssl_partial_shipment_flag

  • Description: Partial Shipment Indicator. Indicates whether the integrated application supports partial shipment.
  • Valid values:
    • Y - Partial shipment supported
    • N - Partial shipment not supported (default)
  • Length: 1
  • Data Type: alphanumeric

ssl_payment_count

  • Description: Installment Count. Total number of payments. Required if ssl_recurring_flag = 2.
  • Length: NA
  • Data Type: numeric

ssl_payment_number

  • Description: Installment Sequence Number. Required if ssl_recurring_flag = 2.
  • Length: NA
  • Data Type: numeric

ssl_phone

  • Description: Phone. Phone number on the cardholder’s / customer’s account or billing address. Important: Accepts dashes.
  • Length: 20
  • Data Type: numeric

ssl_pin

  • Description: 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 terminal that will process the request.
  • Length: 64
  • Data Type: alphanumeric

ssl_pin_block

  • Description: Encrypted PIN Block. The encrypted personal identification number entered by the debit or EBT cardholder to authenticate ownership of the card.
  • Length: 16
  • Data Type: NA

ssl_pos_mode

  • Description: POS Device Data Entry Capability. Indicates how the POS device captures card data.
  • Valid values:
    • 01 - Manual entry only
    • 02 - Magnetic swipe-capable
    • 03 - Proximity or contactless-capable
    • 04 - EMV chip-capable (ICC) - Contact only with magnetic stripe
    • 05 - EMV chip-capable (ICC) - Dual interface with magnetic stripe
  • Length: 2
  • Data Type: numeric

ssl_prescription_amount

  • Description: Prescription Amount. Amount of prescription drug expenditures. Defaults to 0.00 if not sent. This field is only available on terminals with Healthcare enabled.
  • Length: NA
  • Data Type: numeric

ssl_processing_code

  • Description: Processing Code. Type of Canadian debit transaction.
  • Valid values:
    • 000000 - Debit Purchase from the Default Account (Flash Only)
    • 001000 - Debit Purchase from Savings
    • 002000 - Debit Purchase from Checking
    • 091000 - Debit Purchase with Cashback from Savings
    • 092000 - Debit Purchase with Cashback from Checking
    • 200000 - Debit Return from the Default Account (Flash Only)
    • 200010 - Debit Return from Savings
    • 200020 - Debit Return from Checking
    • 220000 - Void of a Debit Purchase from the Default Account (Flash Only)
    • 220010 - Void of a Debit Purchase from Savings
    • 220020 - Void of a Debit Purchase from Checking
    • 020000 - Void of a Debit Return from the Default Account (Flash Only)
    • 021000 - Void of a Debit Return from Savings
    • 022000 - Void of a Debit Return from Checking
  • Length: 6
  • Data Type: numeric

ssl_product_string

  • Description: Product String. List of products purchased from the merchant website. All the products appear as Line Items on the Click to Pay website along with the total amount.Format: Unit Price::Quantity::Description::Image URL. Multi-Product Format: Unit Price::Quantity::Description::Image URL; Unit Price::Quantity::Description::Image URL
  • Length: 200
  • Data Type: alphanumeric

ssl_program_protocol

  • Description: First digit of messageVersion
  • Length: 1
  • Data Type: numeric

ssl_promo_code

  • Description: Promotion Code. The cardholder can only use the promo code once.
  • Length: 10
  • Data Type: alphanumeric

ssl_ps2000_data

  • Description: PS2000 Data. This data will be as received during the original authorization processing. This is a “retain and return” value for terminal based settlement messages. You must store this field with the payment details from the transaction to make future Card On File transactions. You must include these fields in the transaction request, for all future Card On File transactions using Token or Card Number.
  • Length: 22
  • Data Type: alphanumeric

ssl_receipt_apprvl_footer_htmml

  • Description: Receipt Footer - Approval. Footer text that appears on the receipt of approved transactions. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval; Receipt Footer. Important: If ssl_result_format = ASCII, Converge ignores the value of this parameter.
  • Length: 255
  • Data Type: alphanumeric

ssl_receipt_apprvl_header_html

  • Description: Receipt Header - Approval. Header text that appears on the receipt of approved transactions. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval; Receipt Header.Important: If ssl_result_format = ASCII, Converge ignores the value of this parameter.
  • Length: 255
  • Data Type: alphanumeric

ssl_receipt_apprvl_method

  • Description: Receipt Link Method - Approval. Indicates the method for displaying the receipt and data of approved transactions. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval; Link Method. Important:
    • If ssl_result_format = ASCII, Converge ignores the LINK, or POST value of this parameter.
    • If not null, Converge overwrites ssl_receipt_decl_method and ssl_receipt_link_method
  • Valid values:
    • REDG - Does not display the receipt and redirects the data to the URL specified in ssl_receipt_link_url
    • LINK - Displays the receipt and provides a link that returns to the URL specified in ssl_receipt_link_url
    • POST - Displays the receipt and provides a button that sends the POST data to the URL specified in ssl_receipt_link_url
  • Length: 4
  • Data Type: alphanumeric

ssl_receipt_apprvl_post_url

  • Description: Receipt URL - POST Approval. Target URL of the link at the bottom of the receipt for an approval using the POST method. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval; URL. Important: If ssl_result_format = ASCII and ssl_receipt_link_method = LINK or POST, Converge ignores the value of this parameter.
  • Length: 255
  • Data Type: alphanumeric

ssl_receipt_apprvl_text

  • Description: Receipt Button/Link Label - Approval. Label of the button or link that appears on approved transactions. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval; Button Text.
  • Length: 40
  • Data Type: alphanumeric

ssl_receipt_decl_footer_html

  • Description: Receipt Footer - Decline. Footer text that appears on the receipt of declined transactions. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Declined; Receipt Footer. Important: If ssl_result_format = ASCII, Converge ignores the value of this parameter.
  • Length: 255
  • Data Type: alphanumeric

ssl_receipt_decl_header_html

  • Description: Receipt Header - Decline. Header text that appears on the receipt of declined transactions. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Declined; Receipt Header. Important: If ssl_result_format = ASCII, Converge ignores the value of this parameter.
  • Length: 255
  • Data Type: alphanumeric

ssl_receipt_decl_method

  • Description: Receipt Link Method - Decline. Indicates the method for displaying the receipt and data of declined transactions. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Declined; Link Method. Important:
    • If ssl_result_format = ASCII, Converge ignores the LINK, or POST value of this parameter.
    • If not null, Converge overwrites ssl_receipt_decl_method and ssl_receipt_link_method.
  • Valid values:
    • REDG - Does not display the receipt and redirects the data to the URL specified in ssl_receipt_link_url
    • LINK - Displays the receipt and provides a link that returns to the URL specified in ssl_receipt_link_url
    • POST - Displays the receipt and provides a button that sends the POST data to the URL specified in ssl_receipt_link_url
  • Length: 4
  • Data Type: alphanumeric

ssl_receipt_decl_post_url

  • Description: Receipt URL - POST Decline. Target URL of the link at the bottom of the receipt for a decline using the POST method. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Declined; URL. Important: If ssl_result_format = ASCII and ssl_receipt_link_method = LINK or POST, Converge ignores the value of this parameter.
  • Length: 255
  • Data Type: alphanumeric

ssl_receipt_decl_text

  • Description: Receipt Button/Link Label - Decline. Label of the button or link that appears on declined transactions. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Declined; Button Text
  • Length: 40
  • Data Type: alphanumeric

ssl_receipt_footer_html

  • Description: Receipt Footer. Footer text that appears on the receipt of an approved or declined transaction. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval and Declined; Receipt Footer. Important: If ssl_result_format = ASCII, Converge ignores the value of this parameter.
  • Length: 255
  • Data Type: alphanumeric

ssl_receipt_header_html

  • Description: Receipt Header. Header text that appears on the receipt of an approved or declined transaction. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval and Declined; Receipt Header. Important: If ssl_result_format = ASCII, Converge ignores the value of this parameter.
  • Length: 255
  • Data Type: alphanumeric

ssl_receipt_link_method

  • Description: Receipt Link Method. Indicates the method for displaying the receipt and data of an approved or declined transaction. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval and Declined; Link Method. Important:
    • If ssl_result_format = ASCII, Converge ignores the LINK, or POST value of this parameter.
    • If not null, Converge overwrites the values of ssl_receipt_apprvl_method and ssl_receipt_decl_method with the value of this parameter.
  • Valid values:
    • REDG - Does not display the receipt and redirects the data to the URL specified in ssl_receipt_link_url
    • LINK - Displays the receipt and provides a link that returns to the URL specified in ssl_receipt_link_url
    • POST - Displays the receipt and provides a button that sends the POST data to the URL specified in ssl_receipt_link_url
  • Length: 4
  • Data Type: alphanumeric

ssl_receipt_link_text

  • Description: Receipt Button/Link Label. Label of the button or link that appears at the bottom of the receipt for an approved or declined transaction. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval and Declined; Button Text. Important:
    • If ssl_result_format = ASCII, Converge ignores the value of this parameter.
    • If not null, Converge overwrites the values of ssl_receipt_apprvl_text and ssl_receipt_decl_text with the value of this parameter.
  • Length: 40
  • Data Type: alphanumeric

ssl_receipt_link_url

  • Description: Receipt URL. Target URL of the button or the link created at the bottom of the receipt for an approved or declined transaction. Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval and Declined; URL. Important:
    • If ssl_result_format = ASCI and ssl_receipt_link_method = POST or REDG, Converge ignores the value of this parameter.
    • If not null, Converge overwrites the values of ssl_receipt_apprvl_post_url, and ssl_receipt_decl_post_url with the value of this parameter.
  • Length: 255
  • Data Type: alphanumeric

ssl_recurring_flag

  • Description: Recurring Flag. Indicates whether the transaction is a recurring or an installment payment.
  • Valid values:
    • 1 - Recurring
    • 2 - Installment
  • Length: 1
  • Data Type: numeric

ssl_recurring_id

  • Description: Recurring ID. Unique identifier of the added, updated or deleted recurring payment record.
  • Length: 50
  • Data Type: alphanumeric

ssl_reference_number

  • Description: Transaction Reference Number. Unique transaction reference number returned in the authorization response message. Used as a request parameter for a Debit Return (dbreturn) transaction.
  • Length: 8
  • Data Type: numeric

ssl_response_file

  • Description: Import Response File Friendly Name. Easy to understand file name of the import response file. Important: The value must not contain a forward slash, backward slash, colon, asterisk, question mark, quotation mark, greater than symbol, less than symbol or a pipe character.
  • Length: 25
  • Data Type: alphanumeric

ssl_result_format

  • Description: Result Format. Elavon recommends an ASCII format when submitting a transaction to Converge through an intermediary application instead of sending a transaction directly from an HTML form that is driven by the actions of the customer on the website.
  • Valid values:ASCII, HTML
  • Length: 5
  • Data Type: alphanumeric

ssl_salestax

  • Description: Sales Tax. Tax amount to add to the purchase or sales amount. For a tax exempt transaction, enter 0.00. Recommended for Purchasing Cards. Format: Amount with 2 decimal places.
  • Length: 8
  • Data Type: alphanumeric

ssl_salestax_indicator

  • Description: Sales Tax Indicator. Whether tax is included on a transaction. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Valid values:
    • Visa
      • 0 - Tax Exempted Sale for Visa (card acceptor has the ability to provide tax amount, but goods/services were not taxable)
      • 1 - Sales Tax Included for Visa
      • 2 - Transaction not subject to Tax for Visa
    • MasterCard
      • Y - Sales Tax Included for MasterCard
      • N - Tax Exempted Sale for MasterCard (card acceptor has the ability to provide tax amount, but goods/services were not taxable)
  • Length: -
  • Data Type: alphanumeric

ssl_search_card_short_description

  • Description: Search Filter - Card Short Description. Retrieve transactions based on card brands. Important: Only applicable to queries based on a date range and/or ssl_card_number, ssl_track_data or ssl_card_suffix.
  • Valid values:
    • AMEX - American Express
    • CUP - China Union Pay
    • DISC - Discover
    • MC - MasterCard
    • PP - PayPal
    • VISA - Visa
  • Length: -
  • Data Type: alphanumeric

ssl_search_card_type

  • Description: Search Filter - Payment Type. Retrieve transactions based on payment types.
  • Valid values:  CASH,  CREDITCARD,  DEBITCARD,  FOODSTAMP,  GIFTCARD,  LOYALTY
  • Length: 10
  • Data Type: alphanumeric

ssl_search_description

  • Description: Search Filter - Merchant-defined Transaction Description. Retrieve transactions based on the merchant’s custom transaction description. Important: Only applicable to queries based on a date range and/or ssl_card_number, ssl_track_data or ssl_card_suffix
  • Length: 255
  • Data Type: alphanumeric

ssl_search_end_date

  • Description: Search Filter - End Date. End date for the transaction date range. If you submit an end date without a start date, Converge sets the value of ssl_search_start_date to ssl_search_end_date minus 31 days. Default: Start date + 31 days. Format: MM/DD/YYYY
  • Length: 10
  • Data Type: alphanumeric

ssl_search_first_name

  • Description: Search Filter - First Name. Retrieve transactions based on the first names sent in the original transactions. Important: Only applicable to queries based on a date range and/or ssl_card_number, ssl_track_data or ssl_card_suffix
  • Length: 50
  • Data Type: alphanumeric

ssl_search_last_name

  • Description: Search Filter - Last Name. Retrieve transactions based on the last names sent in the original transactions. Important: Only applicable to queries based on a date range and/or ssl_card_number, ssl_track_data or ssl_card_suffix
  • Length: 50
  • Data Type: alphanumeric

ssl_search_max_amount

  • Description: Search Filter - Maximum Amount. Maximum value for the transaction amount range. Values must be greater than ssl_search_min_amount. Important: Only applicable to queries based on a date range and/or ssl_card_number, ssl_track_data or ssl_card_suffix
  • Length: 11
  • Data Type: numeric

ssl_search_min_amount

  • Description: Search Filter - Minimum Amount. Minimum value for the transaction amount range. Values must be equal to or less than ssl_search_max_amount. Important: Only applicable to queries based on a date range and/or ssl_card_number, ssl_track_data or ssl_card_suffix
  • Length: 11
  • Data Type: numeric

ssl_search_start_date

  • Description: Search Filter - Start Date. Start date for the transaction date range. If you submit a start date without an end date, Converge sets the value of ssl_search_end_date to ssl_search_start_date plus 31 days. Default: End date - 31 days. Format: MM/DD/YYYY
  • Length: 10
  • Data Type: alphanumeric

ssl_search_taxed

  • Description: Search Filter - Taxed Transaction. Retrieve transactions based on sales taxes.
  • Valid values:
    • T - Search transactions with sales taxes
    • F - Search transactions without sales taxes
    Important: Only applicable to queries based on a date range and/or ssl_card_number, ssl_track_data or ssl_card_suffix
  • Length: 1
  • Data Type: alphanumeric

ssl_search_tipped

  • Description: Search Filter - Tipped Transaction. Retrieve transactions based on tip amounts. Important: Only applicable to queries based on a date range and/or ssl_card_number, ssl_track_data or ssl_card_suffix.
  • Valid values:
    • T - Search transactions with tip amounts
    • F - Search transactions without tip amounts
  • Length: 1
  • Data Type: alphanumeric

ssl_search_transaction_type

  • Description: Search Filter - Transaction Type. Retrieve transactions based on transaction types. Important: Only applicable to queries based on a date range and/or ssl_card_number, ssl_track_data or ssl_card_suffix
  • Length: 20
  • Data Type: alphanumeric

ssl_security_code

  • Description: Card Security Code. Unique verification code assigned to the cardholder’s gift card or loyalty card account.
  • Length: 6
  • Data Type: numeric

ssl_server

  • Description: Server ID. Unique identifier of the clerk, waiter, waitress or cashier. Important: Only applicable to terminals that set up for the Service market segment.
  • Length: 8
  • Data Type: alphanumeric

ssl_shift

  • Description: Shift ID. Unique identifier of the time period, course or service type. Important: Only applicable to terminals that set up for the Service market segment.
  • Length: 4
  • Data Type: alphanumeric

ssl_ship_from_postal_code

  • Description: ZIP Code. ZIP or postal code of the originating address. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 9
  • Data Type: alphanumeric

ssl_ship_to_address1

  • Description: Address Line 1. House number and street name on the shipping address.
  • Length: 30
  • Data Type: alphanumeric

ssl_ship_to_address2

  • Description: Address Line 2. Apartment or condominium unit number and floor number on the shipping address.
  • Length: 30
  • Data Type: alphanumeric

ssl_ship_to_city

  • Description: City. Name of the city on the shipping address.
  • Length: 30
  • Data Type: alphanumeric

ssl_ship_to_company

  • Description: Company Name. Name of the company (recipient) on the shipping address.
  • Length: 50
  • Data Type: alphanumeric

ssl_ship_to_country

  • Description: Country. Country ISO code on the shipping address.
  • Length: 3
  • Data Type: alphanumeric

ssl_ship_to_first_name

  • Description: First Name. First name of the recipient on the shipping address.
  • Length: 50
  • Data Type: alphanumeric

ssl_ship_to_last_name

  • Description: Last Name. Last name of the recipient on the shipping address.
  • Length: 50
  • Data Type: alphanumeric

ssl_ship_to_phone

  • Description: Phone. Phone number on the shipping address.
  • Length: 10
  • Data Type: numeric

ssl_ship_to_state

  • Description: State Code. State code on the shipping address.
  • Length: 2
  • Data Type: alphanumeric

ssl_ship_to_zip

  • Description: ZIP Code. Postal or ZIP code on the shipping address.
  • Length: 9
  • Data Type: alphanumeric

ssl_signature_image

  • Description: Signature Image. Digital version of the cardholder’s signature.
  • Length: BLOB
  • Data Type: Base64 Encoded

ssl_shipping_amount

  • Description: Freight or Shipping Amount. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 11
  • Data Type: numeric

ssl_shipping_company

  • Description: Shipping Company Name. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 50
  • Data Type: alphanumeric

ssl_skip_payment

  • Description: Skip Payment Indicator.
  • Valid values:
    • Y - Skip payment
    • N - Do not skip payment (Default)
  • Length: 1
  • Data Type: alphanumeric

ssl_state

  • Description: State Code. State or province code on the cardholder’s / customer’s account or billing address.
  • Length: 2
  • Data Type: alphanumeric

ssl_status_code

  • Description: Account Status
  • Valid values:
    • A - Account Information Updated
    • B - Expiry Date Updated
    • C - Account Closed
    • D - Contact Customer
    • G - Non-participating BIN
  • Length: 1
  • Data Type: alphanumeric

ssl_summary_commodity_code

  • Description: Summary Commodity Code. Indicates whether Level 3 data is in the line item detail. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 4
  • Data Type: alphanumeric

ssl_sys_trace_audit_no

  • Description: System Trace Audit Number. The POS uses this number in the Canadian debit authorization request message to identify uniquely the transaction to the host. This number also used in the Message Authentication Code (MAC) calculation.
  • Length: 6
  • Data Type: NA

ssl_table_color

  • Description: Payment Form Table Header Text and Background Color. HTML hexadecimal code for the table header text and background colors. Default value - Set in terminal: Payment Form; Payment Form Setup; Payment Form Color; Table Header Text and Background
  • Length: 20
  • Data Type: alphanumeric

ssl_text_color

  • Description: Payment Form Text Color. HTML hexadecimal code for the body text and table text colors. Default value - Set in terminal: Payment Form; Payment Form Setup; Payment Form Color; Body and Table Text
  • Length: 20
  • Data Type: alphanumeric

ssl_time_zone_request_utc

  • Description: Time zone in Coordinated Universal Time (UTC). Important:ssl_time_zone_request_utc works completely independent of ssl_time_zone_response_utcFormat: MM/DD/YYYY hh:mm:ss. Example: 12/28/2021 10:34:10
    • Y - Convert any provided timestamps into UTC format
    • N - Does not convert the timestamps into UTC
  • Length: 20
  • Data Type: alphanumeric

ssl_time_zone_response_utc

  • Description: Time zone in Coordinated Universal Time (UTC). Format: MM/DD/YYYY hh:mm:ss. Example: 12/28/2021 10:34:10
    • Y - Display the time zone in UTC
      • If Y is selected, then ssl_txn_time_utc, ssl_settle_time_utc, ssl_service_fee_txn_time_utc, ssl_search_start_date, ssl_search_end_date will display in UTC format
    • N - Does not display the time zone in UTC
  • Length: 20
  • Data Type: alphanumeric

ssl_tip_amount

  • Description: Tip or Gratuity Amount. Amount to add or update to the transaction amount. Important: Only applicable to terminals that are set up for the Service market segment. Format: Number with 2 decimals places
  • Length: 11
  • Data Type: numeric

ssl_tlv_enc

  • Description: Encrypted Tag Length Value. Extracted from a PIN Pad device that supports an Ingenico encypting device. This value includes the total authorization amount and tip amount (if available).
  • Length: 4
  • Data Type: hex

ssl_token

  • Description: Credit Card Token. Encrypted card data that can replace credit card numbers on subsequent transactions. You can store and update tokens in Card Manager.
  • Length: 20
  • Data Type: alphanumeric

ssl_token_provider

  • Description: Credit Card Token Provider. This code indicates the provider for the token. This value is also visible in the Converge UI.
  • Valid values:
    • P for legacy tokens.
    • V for Voltage tokens
  • Length: 1
  • Data Type: alphanumeric

ssl_total_installments

  • Description: Number of Payments. Total number of installment payments for a transaction.
  • Length: 4
  • Data Type: numeric

ssl_track_data

  • Description: Raw Track I and/or II Data. Track data captured from the card’s magnetic stripe. The data includes beginning and ending sentinels, card’s expiry date, cardholder’s first name, and the cardholder’s last name.
  • Length: 76
  • Data Type: alphanumeric

ssl_tracking_number

  • Description: Shipping Tracking Number. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 25
  • Data Type: alphanumeric

ssl_transaction_currency

  • Description: Transaction Currency. The currency ISO code that the merchant applies to their goods or services. Important: Only applicable to terminals that are set up with the Multi Currency credit payment option. Default: USD or CAD
  • Length: 3
  • Data Type: alphanumeric

ssl_transaction_source

  • Description: Transaction Source. The source of the transaction request.
  • Length: 20
  • Data Type: alphanumeric

ssl_transaction_type

  • Description: Transaction Type. Refer to the Transaction Types section for the complete list of transaction types that are available to each payment type.
  • Length: 20
  • Data Type: alphanumeric

ssl_transit_amount

  • Description: Transit Amount. Amount of transit expenditures. Defaults to 0.00 if not sent. Requests that include Transit Amount must be sent separately from healthcare transactions that include other healthcare amount fields.
  • Length:
  • Data Type: numeric

ssl_txn_id

  • Description: Transaction ID. Unique identifier of the approved or denied transaction.
  • Length: 46
  • Data Type: alphanumeric

ssl_update_email

  • Description: Update Email Address Indicator. Indicates whether to modify the cardholder’s email address after sending the order confirmation email.
  • Valid values:
    • Y - Update email address
      • Important: If ssl_update_email = Y, send the new email address using the ssl_email parameter.
    • N - Do not update email address
  • Length: 1
  • Data Type: alphanumeric

ssl_user_id

  • Description: Converge User ID. The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
  • Length: 15
  • Data Type: alphanumeric

ssl_vat_invoice_number

  • Description: VAT Invoice Number. Important: Only applicable to terminals that are set up with the Level 3 terminal option.
  • Length: 15
  • Data Type: alphanumeric

ssl_vendor_app_name

  • Description: Vendor’s Application Name
  • Length: 50
  • Data Type: alphanumeric

ssl_vendor_app_version

  • Description: Vendor’s Application Version
  • Length: 50
  • Data Type: alphanumeric

ssl_vendor_id

  • Description: Vendor id
  • Length: 20
  • Data Type: alphanumeric

ssl_verify

  • Description: Account Verification Indicator. Indicates whether Converge needs to verify the account before generating a token.
  • Valid values:
    • Y - Verify account prior to token generation
    • N - Generate token without account verification
  • Length: 1
  • Data Type: alphanumeric

ssl_visapayload

  • Description: Visa Payload
  • Length: 4000
  • Data Type: alphanumeric

ssl_vision_amount

  • Description: Vision Amount. Amount of vision expenditures. Defaults to 0.00 if not sent.
  • Length: NA
  • Data Type: numeric

ssl_vm_mobile_device

  • Description: Mobile Device Type. The type of mobile device from which the transaction originates.
  • Valid values:
    • BBERRY - BlackBerry mobile device
    • ADROID - Android mobile device
    • ITUNES - Apple mobile device
    • WIN8 - Windows WIN8-based mobile device
    • NOMOB - Non-mobile device
  • Length: NA
  • Data Type: NA

ssl_voucher_number

  • Description: Voucher Clear Number. Derived from the merchant’s Food Stamp sales slip.
  • Length: 15
  • Data Type: alphanumeric

ssl_xid

  • Description: eMPI Transaction ID. Unique transaction identifier generated by the Elavon Merchant Plug In (eMPI) engine.
  • Length: 20
  • Data Type: alphanumeric