Supported Transaction Input Fields

Field nameDescriptionLengthData type
ssl_3dsecure_valueCardholder Authentication Verification (CAVV) (Visa)
Universal Cardholder Authentication Field (UCAF) (MasterCard)
Validates the integrity of the Verified by Visa (VbV) transaction data.
80Base64 Encoded
ssl_aba_numberRouting 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.
9alphanumeric
ssl_account_typeBank Deposit Account Type
Valid values:
  • 0 - Checking
  • 1 - Saving
1numeric
ssl_add_tokenAdd to Card Manager Indicator
Indicates whether to generate and store the token in Card Manager.
Valid values:
  • Y - Generate and store token
  • N - Do not store token (Default)
Important: Only applicable to terminals that are set up with the Tokenization  terminal option.
1alphanumeric
ssl_address2Address Line 2
Apartment or condominium unit number and floor number on the cardholder’s or customer’s account or billing address.
30alphanumeric
ssl_agreeAgreement Indicator
Valid values:
  • 0 - Does not agree
  • 1 - Agrees
Required for ACH ECheck transactions.
1numeric
ssl_amountTransaction 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
11numeric
ssl_applepay_billingBilling Address
The billing address in the cardholder’s Apple Pay account.
4000alphanumeric
ssl_applepay_shippingShipping Address
The shipping address in the cardholder’s Apple Pay account.
4000alphanumeric
ssl_applepay_web 4000alphanumeric
ssl_approval_codeTransaction Approval Code
Unique code returned by the credit card processor that indicates the approval status of the transaction.
6numeric
ssl_avs_addressAddress 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.
30alphanumeric
ssl_avs_zipPostal 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.
9alphanumeric
ssl_background_colorPayment 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
20alphanumeric
ssl_bank_account_numberBank Account Number
Unique identifier of the checking account.
Only applicable to ACH ECheck transactions.
16numeric
ssl_bank_account_typeBank Account Type
Indicates the type of checking account.
Valid values:
  • 0 - Personal
  • 1 - Business
Required for ACH ECheck transactions.
1numeric
ssl_bill_on_halfHalf 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
1numeric
ssl_billing_cycleBilling Cycle
Valid values:  DAILYWEEKLYBIWEEKLYSEMIMONTHLYMONTHLYBIMONTHLYQUARTERLYSEMESTERSEMIANNUALLYANNUALLYSUSPENDED
12alphanumeric
ssl_bin_overrideOverride 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.
1numeric
ssl_card_numberCard Number
Unique card identification number.
Card length:
  • 18 - Gift Card
  • 19 - Credit Card
18 or 19numeric
ssl_callback_urlCallback URL
The URL of the merchant that will host the response.
200alphanumeric
ssl_card_presentCard Present Indicator
Indicates whether the card is physically present during the transaction.
Valid values:
  • Y - Card present
  • N - Card not present
Recommended for hand-keyed transactions.
1alphanumeric
ssl_card_suffixLast 4 Digits4numeric
ssl_card_typeCard Type
Payment method to use for the transaction.
Valid values:  CREDITCARDDEBITCARDFOODSTAMPCASHBENEFITELECTRONICCHECKGIFTCARDLOYALTYCASH
10alphanumeric
ssl_cardholder_ipCardholder IP Address40alphanumeric
ssl_cardholder_tip_amountTip 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
11numeric
ssl_cashback_amountCashback 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
12numeric
ssl_check_imageCheck Image
Scanned and encoded image of the check.
Only applicable to ECS Paper Check Conversion transactions.
BLOBBase64 Encoded TIFF
ssl_check_numberCheck Number
Unique identifier commonly printed at the bottom of the check.
Only applicable to ACH ECheck transactions.
16numeric
ssl_cityCity
City name on the cardholder’s / customer’s account or billing address.
30alphanumeric
ssl_client_api_platformTransaction Source Platform
Operating system of the transaction source.
50alphanumeric
ssl_client_api_platform_versionTransaction Source Platform Version
Version of the transaction source’s operating system.
50alphanumeric
ssl_client_api_sourceTransaction Source
Name of the application from which the transaction originates.
50alphanumeric
ssl_client_api_source_versionTransaction Source Version
Version of the transaction source.
50alphanumeric
ssl_companyCompany Name
Company name on the cardholder’s / customer’s account or billing address.
50alphanumeric
ssl_clinic_other_amountClinic/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.
NAnumeric
ssl_completion_DateTravel 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
10alphanumeric
ssl_countryCountry ISO Code
Country ISO code on the cardholder’s / customer’s account or billing address.
3alphanumeric
ssl_customer_codeCustomer 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.
17alphanumeric
ssl_customer_idCustomer ID
Merchant-defined unique customer identifier.
NANA
ssl_customer_numberCustomer/Payee Account Number
Customer or payee account number to submit in a PINless debit (pldpurchase) transaction.
25numeric
ssl_customer_vat_numberCustomer 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.
13alphanumeric
ssl_cvv2cvc2Card 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.
4numeric
ssl_cvv2cvc2_indicatorCard 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
1numeric
ssl_decline_offlineDecline 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
1alphanumeric
ssl_dental_amountDental Amount
Amount of dental expenditures. Defaults to 0.00 if not sent.
This field is only available on terminals with Healthcare enabled.
numeric
ssl_departure_DateTravel 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
10alphanumeric
ssl_descriptionMerchant-defined Transaction Description
Short and custom text to describe the transaction.
255alphanumeric
ssl_discount_amountDiscount Amount
The discount amount for the entire transaction (order).
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
11numeric
ssl_do_customer_emailSend Email to Customer Indicator
Indicates whether to send emails to customers when transactions are approved or declined.
Valid values:
  • T - Send email to customer
  • F - Do not 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.
Default value - Set in terminal: E-mail Form
Email Notification SetupEmail Options
ssl_do_merchant_emailSend Email to Merchant Indicator
Indicates whether to send emails to the merchant when transactions are approved or declined.
Valid values:
  • T - Send email to merchant
  • F - Do not send email to merchant
Defaults to T if ssl_do_merchant_email is null.
Default value - Set in terminal: E-mail Form, Email Notification Setup, Email Options, Notify Merchant of Transaction Approval / Notify Merchant of Transaction Decline
1alphanumeric
ssl_drivers_license_numberDrivers License Number
Unique identification code as it appears on the license.
Required for ECS Paper Check Conversion - Guarantee transactions.
16alphanumeric
ssl_drivers_license_phone_numberPhone Number
Contact number (includes the area code) as it appears on the license.
Required for ECS Paper Check Conversion - Guarantee transactions.
10numeric
ssl_drivers_license_stateState Code
State code as it appears on the license.
Required for ECS Paper Check Conversion - Guarantee transactions.
2alphanumeric
ssl_dukptDUKPT
Value used to encrypt the PIN of the cardholder and returned by the PIN Pad.
20NA
ssl_duty_amountDuty 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.
11numeric
ssl_dynamic_dbaDynamic 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.
21alphanumeric
ssl_dynamic_dba_addressDynamic DBA Address
This value allows a merchant use an alternate address for this transaction.
30alphanumeric
ssl_dynamic_dba_auth_typeMerchant ID
The dynamic doing business as authorization type.
Valid values:
  • F - Final
  • P - Pre-authorize
1alphanumeric
ssl_dynamic_dba_cityDynamic 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
13alphanumeric
ssl_dynamic_dba_countryDynamic 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.
3alphanumeric
ssl_dynamic_dba_emailDynamic Email Address
The dynamic doing business as email address.
This value allows a merchant specify an alternate email address for this transaction.
70alphanumeric
ssl_dynamic_dba_mccDynamic Merchant Category Code
The dynamic doing business as merchant category code.
This value allows a merchant specify an alternate merchant category for this transaction.
22numeric
ssl_dynamic_dba_phoneDynamic Phone Number
The dynamic doing business as phone number.
This value allows a merchant specify an alternate phone number for this transaction.
20alphanumeric
ssl_dynamic_dba_postalDynamic Postal or ZIP Code
The dynamic doing business as postal code.
This value allows a merchant set an alternate postal code for a transaction.
9alphanumeric
ssl_dynamic_dba_stateDynamic State Code
The dynamic doing business as state code.
This value allows a merchant set an alternate state code for a transaction.
2alphanumeric
ssl_dynamic_dba_submidDynamic 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.
22numeric
ssl_dynamic_dba_taxidDynamic Merchant Tax ID
The dynamic doing business as Merchant Tax ID.
This value allows a merchant set an alternate Tax ID for this transaction.
14alphanumeric
ssl_eci_indeCommerce 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)
1numeric
ssl_ecs_product_codeACH Processing Option
Overrides the default ACH type specified in Converge.
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.
Important:
  • WEB, TEL or PPD is required if ssl_bank_account_type = 0.
  • CCD is required if ssl_bank_account_type = 1.
3alphanumeric
ssl_egc_tender_typeTender Type
Tender type to use to pay for the gift card.
Valid values:
  • 0 - Cash
  • 1 - Credit Card
  • 2 - Debit Card
  • 3 - Check
1numeric
ssl_emailEmail Address
The cardholder’s or customer’s email address.
100alphanumeric
ssl_email_apprvl_footer_htmlOrder 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
255alphanumeric
ssl_email_apprvl_header_htmlOrder 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
255alphanumeric
ssl_email_decl_footer_htmlOrder 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
255alphanumeric
ssl_email_decl_header_htmlOrder 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
255alphanumeric
ssl_email_footerOrder 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.
255alphanumeric
ssl_email_headerOrder 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.
255alphanumeric
ssl_enc_loyalty_track_dataEncrypted Track Data
Track data captured from the card’s magnetic stripe or an Ingenico encrypting device.
160alphanumeric
ssl_enc_track_dataEncrypted 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.
160alphanumeric
ssl_enc_track_data_formatEncrypted 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
NANA
ssl_encrypted_loyalty_track1_dataEncrypted Loyalty Track I Data
Track I data captured from a MagTek encrypting device.
160alphanumeric
ssl_encrypted_loyalty_track2_dataEncrypted Loyalty Track II Data
Track II data captured from a MagTek encrypting device.
160alphanumeric
ssl_encrypted_track1_dataEncrypted Raw Track I Data
Track I data captured from a MagTek encrypting device.
160alphanumeric
ssl_encrypted_track2_dataEncrypted Raw Track II Data
Track II data captured from a MagTek encrypting device.
160alphanumeric
ssl_end_of_monthEnd of Month Indicator
Indicates whether to process the recurring transaction on the last day of the month.
Valid values:
  • Y - Yes
  • N - No
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).
1alphanumeric
ssl_enrollmentEnrollment 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
2numeric
ssl_entry_modeTransaction 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)
  • 04 = Proximity/Contactless
  • 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
2numeric
ssl_error_urlError 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
255alphanumeric
ssl_eWalletWallet Identifier
Indicates the wallet payment type offered by the merchant.
Valid value:  MasterPass
10alphanumeric
ssl_eWallet_shippingShipping Information Indicator
Indicates the shipping information to use for the wallet purchase.
Valid values:
  • Y - Use MasterPass shipping information
  • N - Use shipping information from merchant’s website or payment form
1alphanumeric
ssl_exclude_account_updateExclude Account Update
A request with this field set to Y will not pass a token to the account updater.
Optional
1Boolean
ssl_exp_dateCard’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
4numeric
ssl_first_nameFirst Name
First name on the cardholder’s / customer’s account or billing address.
20alphanumeric
ssl_footer_htmlPayment 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
255alphanumeric
ssl_freight_tax_amountVAT 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.
12numeric
ssl_get_tokenGenerate Token Indicator
Indicates whether to generate a token when submitting the card data.
Valid values:
  • Y - Generate token
  • N - Do not generate token (Default)
Only applicable to terminals that are set up with the Tokenization terminal option.
1alphanumeric
ssl_header_colorPayment 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
20alphanumeric
ssl_header_htmlPayment 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
255alphanumeric
ssl_healthcare_amountHealthcare 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.
NAnumeric
ssl_icc_isrIssuer Script Results
Describes the results of the terminal script processing.
84alphanumeric
ssl_icc_tsiTransaction Status Information
Valid values:
  • A - Accepted
  • E - Error Detected
1alphanumeric
ssl_image_typeSignature Image Format
File format of the signature image. Required if ssl_signature_image is submitted.
Valid values:  GIF, TIF, JPG, PNG
3alphanumeric
ssl_import_fileImport 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.
255alphanumeric
ssl_include_signatureInclude 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
-alphanumeric
ssl_install_idInstallment Record ID
Unique identifier of the installment record.
NANA
ssl_installment_idInstallment ID
Unique identifier of the installment record.
50alphanumeric
ssl_invoice_numberInvoice/Ticket Number
Unique identifier of the invoice or ticket.
25alphanumeric
ssl_issue_pointsAccrue Points
Indicates whether to accrue points for the current transaction.
Valid values:
  • Y - Accrue points
  • N - Do not accrue points
1alphanumeric
ssl_key_pointerTriple-DES DUKPT Pointer
Indicates the encryption key used on US debit transactions.
Valid value:  T - Triple-DES DUKPT
1alphanumeric
ssl_ksnKey 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.
20alphanumeric
ssl_last_nameLast Name
Last name on the cardholder’s / customer’s account or billing address.
30alphanumeric
ssl_level3_indicatorLevel 3 Indicator
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)
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
1alphanumeric
ssl_line_Item_alternative_taxAlternate 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.
12numeric
ssl_line_Item_commodity_codeLine 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.
12alphanumeric
ssl_line_item_descriptionLine Item Description
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
25alphanumeric
ssl_line_item_discount_amountDiscount Amount
The discount amount for the entire line item.
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
11numeric
ssl_line_Item_discount_indicatorLine Item Discount Indicator
Indicates whether the line item is discounted.
  • Y - Item amount is discounted
  • N - Item amount is not discounted
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
1alphanumeric
ssl_line_Item_extended_totalLine 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.
9numeric
ssl_line_Item_product_codeLine 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.
12alphanumeric
ssl_line_Item_quantityLine 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.
12numeric
ssl_line_Item_unit_costLine 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.
12numeric
ssl_line_Item_unit_of_measureLine 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.
3alphanumeric
ssl_line_Item_tax_amountLine 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.
12numeric
ssl_line_Item_tax_indicatorLine Item Tax Indicator
Indicates whether the line item is taxable.
  • Y - Item amount is taxable
  • N - Item amount is not taxable
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
1alphanumeric
ssl_line_Item_tax_rateLine Item Tax Rate
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
4numeric
ssl_line_Item_tax_typeLine 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.
4alphanumeric
ssl_line_Item_totalLine Item Total Amount
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
12numeric
ssl_link_colorPayment 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
20alphanumeric
ssl_loyalty_card_numberLoyalty Card Number
Unique identifier of the loyalty card.
19numeric
ssl_loyalty_exp_dateLoyalty Card’s Expiry Date
Date when the card becomes invalid.
Format: MMYY
4numeric
ssl_loyalty_track_dataLoyalty Card Track Data
Track data captured from the card’s magnetic stripe.
76alphanumeric
ssl_mac_valueMessage Authentication Code
Authenticates that the Canadian debit message was not modified.
8hex
ssl_merchant_emailMerchant’s Email Address
If null and ssl_do_merchant_email = T, Converge sends the order confirmation email to the email address of the terminal.
100alphanumeric
ssl_merchant_idMerchant ID
Elavon-assigned Converge account ID.
15numeric
ssl_merchant_initiated_unscheduledMerchant 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
1alphanumeric
ssl_merchant_txn_idMerchant Transaction ID
Unique transaction reference number sent to the downstream systems as part of the Encompass ROC data.
39alphanumeric
ssl_merchant_vat_numberMerchant 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.
20alphanumeric
ssl_micr_dataUnformatted 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
80alphanumeric
ssl_mobile_idMobile Device ID
Unique identifier of the mobile device that sends the transaction request.
40alphanumeric
ssl_mpos_acceptance_deviceMobile 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.)
1alphanumeric
ssl_national_tax_indicatorNational Tax Indicator
Visa
  • 0 - Tax not included in total purchase amount
  • 1 - Tax included in total purchase amount
MasterCard
  • Y - Tax included in total purchase amount
  • N - Transaction not subject to tax
  • 0 or Space - Tax information unknown
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
1alphanumeric
ssl_next_payment_dateNext Payment Date
The date of the next scheduled payment for a recurring or installment transaction.
Format: MM/DD/YYYY
10alphanumeric
ssl_oar_dataOAR 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.
20alphanumeric
ssl_order_dateOrder 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.
6numeric
ssl_original_dateOriginal Transaction Date
The date of the original Debit Purchase (dbpurchase) or Food Stamp Purchase (fspurchase) transaction.
Format: MMDDYY
6numeric
ssl_original_timeOriginal Transaction Time
The time of the original Debit Purchase (dbpurchase) or Food Stamp Purchase (fspurchase) transaction.
Format: HHMMSS
6numeric
ssl_otc_amountOver 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.
numeric
ssl_other_feesOther Fees
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
12numeric
ssl_other_taxOther Tax Amount
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
12numeric
ssl_partial_auth_indicatorPartial Authorization Indicator
Indicates whether the integrated application supports partial authorization or approval.
Valid values:
  • 0 - Partial authorization not supported (Default)
  • 1 - Partial authorization supported
1numeric
ssl_partial_shipment_flagPartial Shipment Indicator
Indicates whether the integrated application supports partial shipment.
Valid values:
  • Y - Partial shipment supported
  • N - Partial shipment not supported (default)
1alphanumeric
ssl_payment_countInstallment Count
Total number of payments.
Required if ssl_recurring_flag = 2.
NAnumeric
ssl_payment_numberInstallment Sequence Number
Required if ssl_recurring_flag = 2.
NAnumeric
ssl_phonePhone
Phone number on the cardholder’s / customer’s account or billing address.
Important: Must not include spaces or dashes.
10numeric
ssl_pinTerminal 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.
64alphanumeric
ssl_pin_blockEncrypted PIN Block
The encrypted personal identification number entered by the debit or EBT cardholder to authenticate ownership of the card.
16NA
ssl_pos_modePOS 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
2numeric
ssl_prescription_amountPrescription Amount
Amount of prescription drug expenditures.
Defaults to 0.00 if not sent.
This field is only available on terminals with Healthcare enabled.
NAnumeric
ssl_processing_codeProcessing 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
6numeric
ssl_product_stringProduct String
List of products purchased from the merchant website. All the products appear as Line Items on the MasterPass 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
200alphanumeric
ssl_promo_codePromotion Code
The cardholder can only use the promo code once.
10alphanumeric
ssl_ps2000_dataPS2000 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.
22alphanumeric
ssl_receipt_apprvl_footer_htmlReceipt Footer - Approval
Footer text that appears on the receipt of approved transactions.
Important: If ssl_result_format = ASCII, Converge ignores the value of this parameter.
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval; Receipt Footer
255alphanumeric
ssl_receipt_apprvl_get_urlReceipt URL - GET/REDG Approval
Target URL of the link at the bottom of the receipt for an approval using the GET method or the target of the redirect for an approval using the REDG method.
Important: If ssl_result_format = ASCII and ssl_receipt_link_method = LINK or POST, Converge ignores the value of this parameter.
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval; Link Method
255alphanumeric
ssl_receipt_apprvl_header_htmlReceipt Header - Approval
Header text that appears on the receipt of approved transactions.
Important: If ssl_result_format = ASCII, Converge ignores the value of this parameter.
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval; Receipt Header
255alphanumeric
ssl_receipt_apprvl_methodReceipt Link Method - Approval
Indicates the method for displaying the receipt and data of approved transactions.
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
  • GET - Displays the receipt and provides a button that sends the GET data 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
Important:
  • If ssl_result_format = ASCII, Converge ignores the LINK, GET, or POST value of this parameter.
  • If not null, Converge overwrites ssl_receipt_decl_method and ssl_receipt_link_method
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval; Link Method.
4alphanumeric
ssl_receipt_apprvl_post_urlReceipt URL - POST Approval
Target URL of the link at the bottom of the receipt for an approval using the POST method.
Important: If ssl_result_format = ASCII and ssl_receipt_link_method = LINK or POST, Converge ignores the value of this parameter.
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval; URL
255alphanumeric
ssl_receipt_apprvl_textReceipt 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
40alphanumeric
ssl_receipt_decl_footer_htmlReceipt Footer - Decline
Footer text that appears on the receipt of declined transactions.
Important: If ssl_result_format = ASCII, Converge ignores the value of this parameter.
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Declined; Receipt Footer
255alphanumeric
ssl_receipt_decl_get_urlReceipt URL - GET/REDG Decline
Target URL of the link at the bottom of the receipt for a decline using the GET method or the target of the redirect for a decline using the REDG method.
Important: If ssl_result_format = ASCII and ssl_receipt_link_method = LINK or POST, Converge ignores the value of this parameter.
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Declined; Link Method
255alphanumeric
ssl_receipt_decl_header_htmlReceipt Header - Decline
Header text that appears on the receipt of declined transactions.
Important: If ssl_result_format = ASCII, Converge ignores the value of this parameter.
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Declined; Receipt Header
255alphanumeric
ssl_receipt_decl_methodReceipt Link Method - Decline
Indicates the method for displaying the receipt and data of declined transactions.
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
  • GET - Displays the receipt and provides a button that sends the GET data 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
Important:
  • If ssl_result_format = ASCII, Converge ignores the LINK, GET, or POST value of this parameter.
  • If not null, Converge overwrites ssl_receipt_decl_method and ssl_receipt_link_method.

Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Declined; Link Method
4alphanumeric
ssl_receipt_decl_post_urlReceipt URL - POST Decline
Target URL of the link at the bottom of the receipt for a decline using the POST method.
Important: If ssl_result_format = ASCII and ssl_receipt_link_method = LINK or POST, Converge ignores the value of this parameter.
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Declined; URL
255alphanumeric
ssl_receipt_decl_textReceipt 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
40alphanumeric
ssl_receipt_footer_htmlReceipt Footer
Footer text that appears on the receipt of an approved or declined transaction.
Important: If ssl_result_format = ASCII, Converge ignores the value of this parameter.
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval and Declined; Receipt Footer
255alphanumeric
ssl_receipt_header_htmlReceipt Header
Header text that appears on the receipt of an approved or declined transaction.
Important: If ssl_result_format = ASCII, Converge ignores the value of this parameter.
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval and Declined; Receipt Header
255alphanumeric
ssl_receipt_link_methodReceipt Link Method
Indicates the method for displaying the receipt and data of an approved or declined transaction.
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
  • GET - Displays the receipt and provides a button that sends the GET data 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
Important:
  • If ssl_result_format = ASCII, Converge ignores the LINK, GET, 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.
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval and Declined; Link Method
4alphanumeric
ssl_receipt_link_textReceipt Button/Link Label
Label of the button or link that appears at the bottom of the receipt for an approved or declined transaction.
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.
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval and Declined; Button Text
40alphanumeric
ssl_receipt_link_urlReceipt URL
Target URL of the button or the link created at the bottom of the receipt for an approved or declined transaction.
Important:
  • If ssl_result_format = ASCI and ssl_receipt_link_method = GET, POST or REDG, Converge ignores the value of this parameter.
  • If not null, Converge overwrites the values of ssl_receipt_apprvl_post_url, ssl_receipt_decl_post_url, ssl_receipt_apprvl_get_url, and ssl_receipt_decl_get_url with the value of this parameter.
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Approval and Declined; URL
255alphanumeric
ssl_recurring_flagRecurring Flag
Indicates whether the transaction is a recurring or an installment payment.
Valid values:
  • 1 - Recurring
  • 2 - Installment
1numeric
ssl_recurring_idRecurring ID
Unique identifier of the added, updated or deleted recurring payment record.
50alphanumeric
ssl_reference_numberTransaction Reference Number
Unique transaction reference number returned in the authorization response message. Used as a request parameter for a Debit Return (dbreturn) transaction.
8numeric
ssl_response_fileImport 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.
25alphanumeric
ssl_result_formatResult 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
5alphanumeric
ssl_salestaxSales 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.
8alphanumeric
ssl_salestax_indicatorSales Tax Indicator
Whether tax is included on a transaction.
  • Y = Sales Tax Included
  • N or Zero = Tax Exempted Sale (card acceptor has the ability to provide tax amount, but goods/services were not taxable)
-alphanumeric
ssl_search_card_short_descriptionSearch Filter - Card Short Description
Retrieve transactions based on card brands.
Valid values:
  • AMEX - American Express
  • CUP - China Union Pay
  • DISC - Discover
  • MC - MasterCard
  • PP - PayPal
  • VISA - Visa
Important: Only applicable to queries based on a date range and/or ssl_card_number, ssl_track_data or ssl_card_suffix
-alphanumeric
ssl_search_card_typeSearch Filter - Payment Type
Retrieve transactions based on payment types.
Valid values:  CASH,  CREDITCARD,  DEBITCARD,  FOODSTAMP,  GIFTCARD,  LOYALTY
10alphanumeric
ssl_search_descriptionSearch 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
255alphanumeric
ssl_search_end_dateSearch 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
10alphanumeric
ssl_search_first_nameSearch 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
20alphanumeric
ssl_search_last_nameSearch 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
30alphanumeric
ssl_search_max_amountSearch 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
11numeric
ssl_search_min_amountSearch 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
11numeric
ssl_search_start_dateSearch 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
10alphanumeric
ssl_search_taxedSearch 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
1alphanumeric
ssl_search_tippedSearch Filter - Tipped Transaction
Retrieve transactions based on tip amounts.
Valid values:
  • T - Search transactions with tip amounts
  • F - Search transactions without tip amounts
Important: Only applicable to queries based on a date range and/or ssl_card_number, ssl_track_data or ssl_card_suffix
1alphanumeric
ssl_search_transaction_typeSearch 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
20alphanumeric
ssl_security_codeCard Security Code
Unique verification code assigned to the cardholder’s gift card or loyalty card account.
6numeric
ssl_serverServer ID
Unique identifier of the clerk, waiter, waitress or cashier.
Important: Only applicable to terminals that set up for the Service market segment.
8alphanumeric
ssl_shiftShift ID
Unique identifier of the time period, course or service type.
Important: Only applicable to terminals that set up for the Service market segment.
4alphanumeric
ssl_ship_from_postal_codeZIP Code
ZIP or postal code of the originating address.
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
9alphanumeric
ssl_ship_to_address1Address Line 1
House number and street name on the shipping address.
30alphanumeric
ssl_ship_to_address2Address Line 2
Apartment or condominium unit number and floor number on the shipping address.
30alphanumeric
ssl_ship_to_cityCity
Name of the city on the shipping address.
30alphanumeric
ssl_ship_to_companyCompany Name
Name of the company (recipient) on the shipping address.
50alphanumeric
ssl_ship_to_countryCountry
Country ISO code on the shipping address.
3alphanumeric
ssl_ship_to_first_nameFirst Name
First name of the recipient on the shipping address.
20alphanumeric
ssl_ship_to_last_nameLast Name
Last name of the recipient on the shipping address.
30alphanumeric
ssl_ship_to_phonePhone
Phone number on the shipping address.
10numeric
ssl_ship_to_stateState Code
State code on the shipping address.
2alphanumeric
ssl_ship_to_zipZIP Code
Postal or ZIP code on the shipping address.
9alphanumeric
ssl_signature_imageSignature Image
Digital version of the cardholder’s signature.
BLOBBase64 Encoded
ssl_shipping_amountFreight or Shipping Amount
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
11numeric
ssl_shipping_companyShipping Company Name
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
50alphanumeric
ssl_skip_paymentSkip Payment Indicator
Valid values:
  • Y - Skip payment
  • N - Do not skip payment (Default)
1alphanumeric
ssl_stateState Code
State or province code on the cardholder’s / customer’s account or billing address.
2alphanumeric
ssl_status_codeAccount Status
Valid values:
  • A - Account Information Updated
  • B - Expiry Date Updated
  • C - Account Closed
  • D - Contact Customer
  • G - Non-participating BIN
1alphanumeric
ssl_summary_commodity_codeSummary 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.
4alphanumeric
ssl_sys_trace_audit_noSystem 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.
6NA
ssl_table_colorPayment 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
20alphanumeric
ssl_text_colorPayment 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
20alphanumeric
ssl_tip_amountTip 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
11numeric
ssl_tlv_encEncrypted 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).
4hex
ssl_tokenCredit Card Token
Encrypted card data that can replace credit card numbers on subsequent transactions. You can store and update tokens in Card Manager.
20alphanumeric
ssl_token_providerCredit Card Token Provider
This code indicates the provider for the token.
  • P for legacy tokens.
  • V for Voltage tokens
This value is also visible in the Converge UI.
1alphanumeric
ssl_total_installmentsNumber of Payments
Total number of installment payments for a transaction.
4numeric
ssl_track_dataRaw 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.
76alphanumeric
ssl_tracking_numberShipping Tracking Number
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
25alphanumeric
ssl_transaction_currencyTransaction 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
3alphanumeric
ssl_transaction_sourceTransaction Source
The source of the transaction request.
20alphanumeric
ssl_transaction_typeTransaction Type
Refer to the Transaction Types section for the complete list of transaction types that are available to each payment type.
20alphanumeric
ssl_transit_amountTransit 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.
numeric
ssl_txn_idTransaction ID
Unique identifier of the approved or denied transaction.
46alphanumeric
ssl_update_emailUpdate Email Address Indicator
Indicates whether to modify the cardholder’s email address after sending the order confirmation email.
Valid values:
  • Y - Update email address
  • N - Do not update email address
Important: If ssl_update_email = Y, send the new email address using the ssl_email parameter.
1alphanumeric
ssl_user_idConverge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
15alphanumeric
ssl_vat_invoice_numberVAT Invoice Number
Important: Only applicable to terminals that are set up with the Level 3 terminal option.
15alphanumeric
ssl_vendor_app_nameVendor’s Application Name50alphanumeric
ssl_vendor_app_versionVendor’s Application Version50alphanumeric
ssl_vendor_idVendor id20alphanumeric
ssl_verifyAccount 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
1alphanumeric
ssl_visapayloadVisa Payload4000alphanumeric
ssl_vision_amountVision Amount
Amount of vision expenditures. Defaults to 0.00 if not sent.
NAnumeric
ssl_vm_mobile_deviceMobile 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
NANA
ssl_voucher_numberVoucher Clear Number
Derived from the merchant’s Food Stamp sales slip.
15alphanumeric
ssl_xideMPI Transaction ID
Unique transaction identifier generated by the Elavon Merchant Plug In (eMPI) engine.
20alphanumeric