Supported Transaction Input Fields
| Field name | Description | Length | Data type |
|---|---|---|---|
| ssl_3dsecure_value | Cardholder Authentication Verification (CAVV) (Visa) Universal Cardholder Authentication Field (UCAF) (MasterCard) Validates the integrity of the Verified by Visa (VbV) transaction data. | 80 | Base64 Encoded |
| ssl_aba_number | 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. | 9 | alphanumeric |
| ssl_account_type | Bank Deposit Account Type Valid values:
| 1 | numeric |
| ssl_add_token | Add to Card Manager Indicator Indicates whether to generate and store the token in Card Manager. Valid values:
| 1 | alphanumeric |
| ssl_address2 | Address Line 2 Apartment or condominium unit number and floor number on the cardholder’s or customer’s account or billing address. | 30 | alphanumeric |
| ssl_agree | Agreement Indicator Valid values:
| 1 | numeric |
| ssl_amount | 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 | 11 | numeric |
| ssl_applepay_billing | Billing Address The billing address in the cardholder’s Apple Pay account. | 4000 | alphanumeric |
| ssl_applepay_shipping | Shipping Address The shipping address in the cardholder’s Apple Pay account. | 4000 | alphanumeric |
| ssl_applepay_web | 4000 | alphanumeric | |
| ssl_approval_code | Transaction Approval Code Unique code returned by the credit card processor that indicates the approval status of the transaction. | 6 | numeric |
| ssl_avs_address | 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. | 30 | alphanumeric |
| ssl_avs_zip | 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. | 9 | alphanumeric |
| ssl_background_color | 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 | 20 | alphanumeric |
| ssl_bank_account_number | Bank Account Number Unique identifier of the checking account. Only applicable to ACH ECheck transactions. | 16 | numeric |
| ssl_bank_account_type | Bank Account Type Indicates the type of checking account. Valid values:
| 1 | numeric |
| ssl_bill_on_half | Half of the Month or Semimonthly Indicator Indicates when to process recurring or installment payment transactions if ssl_billing_cycle = SEMIMONTHLY.Valid values:
| 1 | numeric |
| ssl_billing_cycle | Billing Cycle Valid values: DAILY, WEEKLY, BIWEEKLY, SEMIMONTHLY, MONTHLY, BIMONTHLY, QUARTERLY, SEMESTER, SEMIANNUALLY, ANNUALLY, SUSPENDED | 12 | alphanumeric |
| ssl_bin_override | Override Bank Identification Number (BIN) Allows the integrated application to pass the ssl_customer_code and/or ssl_salestax values for non-corporate cards.Valid value: 1 - Pass customer code and/or sales tax for non-corporate card transaction requests. | 1 | numeric |
| ssl_card_number | Card Number Unique card identification number. Card length:
| 18 or 19 | numeric |
| ssl_callback_url | Callback URL The URL of the merchant that will host the response. | 200 | alphanumeric |
| ssl_card_present | Card Present Indicator Indicates whether the card is physically present during the transaction. Valid values:
| 1 | alphanumeric |
| ssl_card_suffix | Last 4 Digits | 4 | numeric |
| ssl_card_type | Card Type Payment method to use for the transaction. Valid values: CREDITCARD, DEBITCARD, FOODSTAMP, CASHBENEFIT, ELECTRONICCHECK, GIFTCARD, LOYALTY, CASH | 10 | alphanumeric |
| ssl_cardholder_ip | Cardholder IP Address | 40 | alphanumeric |
| ssl_cardholder_tip_amount | 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 | 11 | numeric |
| ssl_cashback_amount | 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 | 12 | numeric |
| ssl_check_image | Check Image Scanned and encoded image of the check. Only applicable to ECS Paper Check Conversion transactions. | BLOB | Base64 Encoded TIFF |
| ssl_check_number | Check Number Unique identifier commonly printed at the bottom of the check. Only applicable to ACH ECheck transactions. | 16 | numeric |
| ssl_city | City City name on the cardholder’s / customer’s account or billing address. | 30 | alphanumeric |
| ssl_client_api_platform | Transaction Source Platform Operating system of the transaction source. | 50 | alphanumeric |
| ssl_client_api_platform_version | Transaction Source Platform Version Version of the transaction source’s operating system. | 50 | alphanumeric |
| ssl_client_api_source | Transaction Source Name of the application from which the transaction originates. | 50 | alphanumeric |
| ssl_client_api_source_version | Transaction Source Version Version of the transaction source. | 50 | alphanumeric |
| ssl_company | Company Name Company name on the cardholder’s / customer’s account or billing address. | 50 | alphanumeric |
| ssl_clinic_other_amount | 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. | NA | numeric |
| ssl_completion_Date | 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 | 10 | alphanumeric |
| ssl_country | Country ISO Code Country ISO code on the cardholder’s / customer’s account or billing address. | 3 | alphanumeric |
| ssl_customer_code | 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. | 17 | alphanumeric |
| ssl_customer_id | Customer ID Merchant-defined unique customer identifier. | NA | NA |
| ssl_customer_number | Customer/Payee Account Number Customer or payee account number to submit in a PINless debit ( pldpurchase) transaction. | 25 | numeric |
| ssl_customer_vat_number | 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. | 13 | alphanumeric |
| ssl_cvv2cvc2 | 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. | 4 | numeric |
| ssl_cvv2cvc2_indicator | Card Verification Value / Card Validation Code Indicator Indicates the status of the card security code or number during the transaction. Valid values:
| 1 | numeric |
| ssl_decline_offline | Decline Transaction Indicator Indicates the action for the EMV card or reader to take when terminals are offline. Valid values:
| 1 | alphanumeric |
| ssl_dental_amount | Dental 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_Date | 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 | 10 | alphanumeric |
| ssl_description | Merchant-defined Transaction Description Short and custom text to describe the transaction. | 255 | alphanumeric |
| ssl_discount_amount | 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. | 11 | numeric |
| ssl_do_customer_email | Send Email to Customer Indicator Indicates whether to send emails to customers when transactions are approved or declined. Valid values:
ssl_do_customer_email is null.Default value - Set in terminal: E-mail Form | Email Notification Setup | Email Options |
| ssl_do_merchant_email | Send Email to Merchant Indicator Indicates whether to send emails to the merchant when transactions are approved or declined. Valid values:
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 | 1 | alphanumeric |
| ssl_drivers_license_number | Drivers License Number Unique identification code as it appears on the license. Required for ECS Paper Check Conversion - Guarantee transactions. | 16 | alphanumeric |
| ssl_drivers_license_phone_number | Phone Number Contact number (includes the area code) as it appears on the license. Required for ECS Paper Check Conversion - Guarantee transactions. | 10 | numeric |
| ssl_drivers_license_state | State Code State code as it appears on the license. Required for ECS Paper Check Conversion - Guarantee transactions. | 2 | alphanumeric |
| ssl_dukpt | DUKPT Value used to encrypt the PIN of the cardholder and returned by the PIN Pad. | 20 | NA |
| ssl_duty_amount | 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. | 11 | numeric |
| ssl_dynamic_dba | 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. | 21 | alphanumeric |
| ssl_dynamic_dba_address | Dynamic DBA Address This value allows a merchant use an alternate address for this transaction. | 30 | alphanumeric |
| ssl_dynamic_dba_auth_type | Merchant ID The dynamic doing business as authorization type. Valid values:
| 1 | alphanumeric |
| ssl_dynamic_dba_city | 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 | 13 | alphanumeric |
| ssl_dynamic_dba_country | 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. | 3 | alphanumeric |
| ssl_dynamic_dba_email | Dynamic Email Address The dynamic doing business as email address. This value allows a merchant specify an alternate email address for this transaction. | 70 | alphanumeric |
| ssl_dynamic_dba_mcc | 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. | 22 | numeric |
| ssl_dynamic_dba_phone | Dynamic Phone Number The dynamic doing business as phone number. This value allows a merchant specify an alternate phone number for this transaction. | 20 | alphanumeric |
| ssl_dynamic_dba_postal | 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. | 9 | alphanumeric |
| ssl_dynamic_dba_state | Dynamic State Code The dynamic doing business as state code. This value allows a merchant set an alternate state code for a transaction. | 2 | alphanumeric |
| ssl_dynamic_dba_submid | 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. | 22 | numeric |
| ssl_dynamic_dba_taxid | 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. | 14 | alphanumeric |
| ssl_eci_ind | eCommerce Indicator Valid values:
| 1 | numeric |
| ssl_ecs_product_code | ACH Processing Option Overrides the default ACH type specified in Converge. Valid values:
| 3 | alphanumeric |
| ssl_egc_tender_type | Tender Type Tender type to use to pay for the gift card. Valid values:
| 1 | numeric |
| ssl_email | Email Address The cardholder’s or customer’s email address. | 100 | alphanumeric |
| ssl_email_apprvl_footer_html | 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 | 255 | alphanumeric |
| ssl_email_apprvl_header_html | 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 | 255 | alphanumeric |
| ssl_email_decl_footer_html | 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 | 255 | alphanumeric |
| ssl_email_decl_header_html | 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 | 255 | alphanumeric |
| ssl_email_footer | 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. | 255 | alphanumeric |
| ssl_email_header | 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. | 255 | alphanumeric |
| ssl_enc_loyalty_track_data | Encrypted Track Data Track data captured from the card’s magnetic stripe or an Ingenico encrypting device. | 160 | alphanumeric |
| ssl_enc_track_data | 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. | 160 | alphanumeric |
| ssl_enc_track_data_format | 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 | NA | NA |
| ssl_encrypted_loyalty_track1_data | Encrypted Loyalty Track I Data Track I data captured from a MagTek encrypting device. | 160 | alphanumeric |
| ssl_encrypted_loyalty_track2_data | Encrypted Loyalty Track II Data Track II data captured from a MagTek encrypting device. | 160 | alphanumeric |
| ssl_encrypted_track1_data | Encrypted Raw Track I Data Track I data captured from a MagTek encrypting device. | 160 | alphanumeric |
| ssl_encrypted_track2_data | Encrypted Raw Track II Data Track II data captured from a MagTek encrypting device. | 160 | alphanumeric |
| ssl_end_of_month | End of Month Indicator Indicates whether to process the recurring transaction on the last day of the month. Valid values:
| 1 | alphanumeric |
| ssl_enrollment | Enrollment Indicator Indicates how to enroll in the loyalty program. Valid values:
| 2 | numeric |
| ssl_entry_mode | Transaction Entry Indicator Indicates how the track data was captured. Valid values:
| 2 | numeric |
| ssl_error_url | 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 | 255 | alphanumeric |
| ssl_eWallet | Wallet Identifier Indicates the wallet payment type offered by the merchant. Valid value: MasterPass | 10 | alphanumeric |
| ssl_eWallet_shipping | Shipping Information Indicator Indicates the shipping information to use for the wallet purchase. Valid values:
| 1 | alphanumeric |
| ssl_exclude_account_update | Exclude Account Update A request with this field set to Y will not pass a token to the account updater.Optional | 1 | Boolean |
| ssl_exp_date | 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 | 4 | numeric |
| ssl_first_name | First Name First name on the cardholder’s / customer’s account or billing address. | 20 | alphanumeric |
| ssl_footer_html | 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 | 255 | alphanumeric |
| ssl_freight_tax_amount | 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. | 12 | numeric |
| ssl_get_token | Generate Token Indicator Indicates whether to generate a token when submitting the card data. Valid values:
| 1 | alphanumeric |
| ssl_header_color | 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 | 20 | alphanumeric |
| ssl_header_html | 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 | 255 | alphanumeric |
| ssl_healthcare_amount | 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. | NA | numeric |
| ssl_icc_isr | Issuer Script Results Describes the results of the terminal script processing. | 84 | alphanumeric |
| ssl_icc_tsi | Transaction Status Information Valid values:
| 1 | alphanumeric |
| ssl_image_type | Signature Image Format File format of the signature image. Required if ssl_signature_image is submitted.Valid values: GIF, TIF, JPG, PNG | 3 | alphanumeric |
| ssl_import_file | Import File Describes the path, location, file name, and file extension of the import file. Important:
| 255 | alphanumeric |
| ssl_include_signature | Include Signature Indicator Indicates whether to include transactions with signature images to the transaction query results. Valid values:
| - | alphanumeric |
| ssl_install_id | Installment Record ID Unique identifier of the installment record. | NA | NA |
| ssl_installment_id | Installment ID Unique identifier of the installment record. | 50 | alphanumeric |
| ssl_invoice_number | Invoice/Ticket Number Unique identifier of the invoice or ticket. | 25 | alphanumeric |
| ssl_issue_points | Accrue Points Indicates whether to accrue points for the current transaction. Valid values:
| 1 | alphanumeric |
| ssl_key_pointer | Triple-DES DUKPT Pointer Indicates the encryption key used on US debit transactions. Valid value: T - Triple-DES DUKPT | 1 | alphanumeric |
| ssl_ksn | 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. | 20 | alphanumeric |
| ssl_last_name | Last Name Last name on the cardholder’s / customer’s account or billing address. | 30 | alphanumeric |
| ssl_level3_indicator | Level 3 Indicator Valid values:
| 1 | alphanumeric |
| ssl_line_Item_alternative_tax | 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. | 12 | numeric |
| ssl_line_Item_commodity_code | 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. | 12 | alphanumeric |
| ssl_line_item_description | Line Item Description Important: Only applicable to terminals that are set up with the Level 3 terminal option. | 25 | alphanumeric |
| ssl_line_item_discount_amount | 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. | 11 | numeric |
| ssl_line_Item_discount_indicator | Line Item Discount Indicator Indicates whether the line item is discounted.
| 1 | alphanumeric |
| ssl_line_Item_extended_total | 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. | 9 | numeric |
| ssl_line_Item_product_code | 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. | 12 | alphanumeric |
| ssl_line_Item_quantity | 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. | 12 | numeric |
| ssl_line_Item_unit_cost | 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. | 12 | numeric |
| ssl_line_Item_unit_of_measure | 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. | 3 | alphanumeric |
| ssl_line_Item_tax_amount | 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. | 12 | numeric |
| ssl_line_Item_tax_indicator | Line Item Tax Indicator Indicates whether the line item is taxable.
| 1 | alphanumeric |
| ssl_line_Item_tax_rate | Line Item Tax Rate Important: Only applicable to terminals that are set up with the Level 3 terminal option. | 4 | numeric |
| ssl_line_Item_tax_type | 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. | 4 | alphanumeric |
| ssl_line_Item_total | Line Item Total Amount Important: Only applicable to terminals that are set up with the Level 3 terminal option. | 12 | numeric |
| ssl_link_color | 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 | 20 | alphanumeric |
| ssl_loyalty_card_number | Loyalty Card Number Unique identifier of the loyalty card. | 19 | numeric |
| ssl_loyalty_exp_date | Loyalty Card’s Expiry Date Date when the card becomes invalid. Format: MMYY | 4 | numeric |
| ssl_loyalty_track_data | Loyalty Card Track Data Track data captured from the card’s magnetic stripe. | 76 | alphanumeric |
| ssl_mac_value | Message Authentication Code Authenticates that the Canadian debit message was not modified. | 8 | hex |
| ssl_merchant_email | 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. | 100 | alphanumeric |
| ssl_merchant_id | Merchant ID Elavon-assigned Converge account ID. | 15 | numeric |
| ssl_merchant_initiated_unscheduled | 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:
| 1 | alphanumeric |
| ssl_merchant_txn_id | Merchant Transaction ID Unique transaction reference number sent to the downstream systems as part of the Encompass ROC data. | 39 | alphanumeric |
| ssl_merchant_vat_number | 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. | 20 | alphanumeric |
| ssl_micr_data | 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:
| 80 | alphanumeric |
| ssl_mobile_id | Mobile Device ID Unique identifier of the mobile device that sends the transaction request. | 40 | alphanumeric |
| ssl_mpos_acceptance_device | 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:
| 1 | alphanumeric |
| ssl_national_tax_indicator | National Tax Indicator Visa
| 1 | alphanumeric |
| ssl_next_payment_date | Next Payment Date The date of the next scheduled payment for a recurring or installment transaction. Format: MM/DD/YYYY | 10 | alphanumeric |
| ssl_oar_data | 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. | 20 | alphanumeric |
| ssl_order_date | 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. | 6 | numeric |
| ssl_original_date | Original Transaction Date The date of the original Debit Purchase ( dbpurchase) or Food Stamp Purchase (fspurchase) transaction.Format: MMDDYY | 6 | numeric |
| ssl_original_time | Original Transaction Time The time of the original Debit Purchase ( dbpurchase) or Food Stamp Purchase (fspurchase) transaction.Format: HHMMSS | 6 | numeric |
| ssl_otc_amount | 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. | numeric | |
| ssl_other_fees | Other Fees Important: Only applicable to terminals that are set up with the Level 3 terminal option. | 12 | numeric |
| ssl_other_tax | Other Tax Amount Important: Only applicable to terminals that are set up with the Level 3 terminal option. | 12 | numeric |
| ssl_partial_auth_indicator | Partial Authorization Indicator Indicates whether the integrated application supports partial authorization or approval. Valid values:
| 1 | numeric |
| ssl_partial_shipment_flag | Partial Shipment Indicator Indicates whether the integrated application supports partial shipment. Valid values:
| 1 | alphanumeric |
| ssl_payment_count | Installment Count Total number of payments. Required if ssl_recurring_flag = 2. | NA | numeric |
| ssl_payment_number | Installment Sequence Number Required if ssl_recurring_flag = 2. | NA | numeric |
| ssl_phone | Phone Phone number on the cardholder’s / customer’s account or billing address. Important: Must not include spaces or dashes. | 10 | numeric |
| ssl_pin | Terminal ID Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway. Important: The ssl_user_id sending the transaction request must be associated with terminal that will process the request. | 64 | alphanumeric |
| ssl_pin_block | Encrypted PIN Block The encrypted personal identification number entered by the debit or EBT cardholder to authenticate ownership of the card. | 16 | NA |
| ssl_pos_mode | POS Device Data Entry Capability Indicates how the POS device captures card data. Valid values:
| 2 | numeric |
| ssl_prescription_amount | Prescription Amount Amount of prescription drug expenditures. Defaults to 0.00 if not sent. This field is only available on terminals with Healthcare enabled. | NA | numeric |
| ssl_processing_code | Processing Code Type of Canadian debit transaction. Valid values:
| 6 | numeric |
| ssl_product_string | Product 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 | 200 | alphanumeric |
| ssl_promo_code | Promotion Code The cardholder can only use the promo code once. | 10 | alphanumeric |
| ssl_ps2000_data | 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. | 22 | alphanumeric |
| ssl_receipt_apprvl_footer_html | Receipt 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 | 255 | alphanumeric |
| ssl_receipt_apprvl_get_url | Receipt 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 | 255 | alphanumeric |
| ssl_receipt_apprvl_header_html | Receipt 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 | 255 | alphanumeric |
| ssl_receipt_apprvl_method | Receipt Link Method - Approval Indicates the method for displaying the receipt and data of approved transactions. Valid values:
| 4 | alphanumeric |
| ssl_receipt_apprvl_post_url | Receipt 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 | 255 | alphanumeric |
| ssl_receipt_apprvl_text | 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 | 40 | alphanumeric |
| ssl_receipt_decl_footer_html | Receipt 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 | 255 | alphanumeric |
| ssl_receipt_decl_get_url | Receipt 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 | 255 | alphanumeric |
| ssl_receipt_decl_header_html | Receipt 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 | 255 | alphanumeric |
| ssl_receipt_decl_method | Receipt Link Method - Decline Indicates the method for displaying the receipt and data of declined transactions. Valid values:
Default value - Set in terminal: Receipt Form; Consumer Receipt Setup; Receipt Form - Declined; Link Method | 4 | alphanumeric |
| ssl_receipt_decl_post_url | Receipt 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 | 255 | alphanumeric |
| ssl_receipt_decl_text | 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 | 40 | alphanumeric |
| ssl_receipt_footer_html | Receipt 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 | 255 | alphanumeric |
| ssl_receipt_header_html | Receipt 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 | 255 | alphanumeric |
| ssl_receipt_link_method | Receipt Link Method Indicates the method for displaying the receipt and data of an approved or declined transaction. Valid values:
| 4 | alphanumeric |
| ssl_receipt_link_text | Receipt Button/Link Label Label of the button or link that appears at the bottom of the receipt for an approved or declined transaction. Important:
| 40 | alphanumeric |
| ssl_receipt_link_url | Receipt URL Target URL of the button or the link created at the bottom of the receipt for an approved or declined transaction. Important:
| 255 | alphanumeric |
| ssl_recurring_flag | Recurring Flag Indicates whether the transaction is a recurring or an installment payment. Valid values:
| 1 | numeric |
| ssl_recurring_id | Recurring ID Unique identifier of the added, updated or deleted recurring payment record. | 50 | alphanumeric |
| ssl_reference_number | Transaction Reference Number Unique transaction reference number returned in the authorization response message. Used as a request parameter for a Debit Return ( dbreturn) transaction. | 8 | numeric |
| ssl_response_file | 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. | 25 | alphanumeric |
| ssl_result_format | 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 | 5 | alphanumeric |
| ssl_salestax | 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. | 8 | alphanumeric |
| ssl_salestax_indicator | Sales Tax Indicator Whether tax is included on a transaction.
| - | alphanumeric |
| ssl_search_card_short_description | Search Filter - Card Short Description Retrieve transactions based on card brands. Valid values:
ssl_card_number, ssl_track_data or ssl_card_suffix | - | alphanumeric |
| ssl_search_card_type | Search Filter - Payment Type Retrieve transactions based on payment types. Valid values: CASH, CREDITCARD, DEBITCARD, FOODSTAMP, GIFTCARD, LOYALTY | 10 | alphanumeric |
| ssl_search_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 | 255 | alphanumeric |
| ssl_search_end_date | 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 | 10 | alphanumeric |
| ssl_search_first_name | 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 | 20 | alphanumeric |
| ssl_search_last_name | 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 | 30 | alphanumeric |
| ssl_search_max_amount | 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 | 11 | numeric |
| ssl_search_min_amount | 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 | 11 | numeric |
| ssl_search_start_date | 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 | 10 | alphanumeric |
| ssl_search_taxed | Search Filter - Taxed Transaction Retrieve transactions based on sales taxes. Valid values:
ssl_card_number, ssl_track_data or ssl_card_suffix | 1 | alphanumeric |
| ssl_search_tipped | Search Filter - Tipped Transaction Retrieve transactions based on tip amounts. Valid values:
ssl_card_number, ssl_track_data or ssl_card_suffix | 1 | alphanumeric |
| ssl_search_transaction_type | 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 | 20 | alphanumeric |
| ssl_security_code | Card Security Code Unique verification code assigned to the cardholder’s gift card or loyalty card account. | 6 | numeric |
| ssl_server | Server ID Unique identifier of the clerk, waiter, waitress or cashier. Important: Only applicable to terminals that set up for the Service market segment. | 8 | alphanumeric |
| ssl_shift | 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. | 4 | alphanumeric |
| ssl_ship_from_postal_code | 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. | 9 | alphanumeric |
| ssl_ship_to_address1 | Address Line 1 House number and street name on the shipping address. | 30 | alphanumeric |
| ssl_ship_to_address2 | Address Line 2 Apartment or condominium unit number and floor number on the shipping address. | 30 | alphanumeric |
| ssl_ship_to_city | City Name of the city on the shipping address. | 30 | alphanumeric |
| ssl_ship_to_company | Company Name Name of the company (recipient) on the shipping address. | 50 | alphanumeric |
| ssl_ship_to_country | Country Country ISO code on the shipping address. | 3 | alphanumeric |
| ssl_ship_to_first_name | First Name First name of the recipient on the shipping address. | 20 | alphanumeric |
| ssl_ship_to_last_name | Last Name Last name of the recipient on the shipping address. | 30 | alphanumeric |
| ssl_ship_to_phone | Phone Phone number on the shipping address. | 10 | numeric |
| ssl_ship_to_state | State Code State code on the shipping address. | 2 | alphanumeric |
| ssl_ship_to_zip | ZIP Code Postal or ZIP code on the shipping address. | 9 | alphanumeric |
| ssl_signature_image | Signature Image Digital version of the cardholder’s signature. | BLOB | Base64 Encoded |
| ssl_shipping_amount | Freight or Shipping Amount Important: Only applicable to terminals that are set up with the Level 3 terminal option. | 11 | numeric |
| ssl_shipping_company | Shipping Company Name Important: Only applicable to terminals that are set up with the Level 3 terminal option. | 50 | alphanumeric |
| ssl_skip_payment | Skip Payment Indicator Valid values:
| 1 | alphanumeric |
| ssl_state | State Code State or province code on the cardholder’s / customer’s account or billing address. | 2 | alphanumeric |
| ssl_status_code | Account Status Valid values:
| 1 | alphanumeric |
| ssl_summary_commodity_code | 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. | 4 | alphanumeric |
| ssl_sys_trace_audit_no | 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. | 6 | NA |
| ssl_table_color | 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 | 20 | alphanumeric |
| ssl_text_color | 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 | 20 | alphanumeric |
| ssl_tip_amount | 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 | 11 | numeric |
| ssl_tlv_enc | 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). | 4 | hex |
| ssl_token | Credit Card Token Encrypted card data that can replace credit card numbers on subsequent transactions. You can store and update tokens in Card Manager. | 20 | alphanumeric |
| ssl_token_provider | Credit Card Token Provider This code indicates the provider for the token.
| 1 | alphanumeric |
| ssl_total_installments | Number of Payments Total number of installment payments for a transaction. | 4 | numeric |
| ssl_track_data | 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. | 76 | alphanumeric |
| ssl_tracking_number | Shipping Tracking Number Important: Only applicable to terminals that are set up with the Level 3 terminal option. | 25 | alphanumeric |
| ssl_transaction_currency | 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 | 3 | alphanumeric |
| ssl_transaction_source | Transaction Source The source of the transaction request. | 20 | alphanumeric |
| ssl_transaction_type | Transaction Type Refer to the Transaction Types section for the complete list of transaction types that are available to each payment type. | 20 | alphanumeric |
| ssl_transit_amount | 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. | numeric | |
| ssl_txn_id | Transaction ID Unique identifier of the approved or denied transaction. | 46 | alphanumeric |
| ssl_update_email | Update Email Address Indicator Indicates whether to modify the cardholder’s email address after sending the order confirmation email. Valid values:
ssl_update_email = Y, send the new email address using the ssl_email parameter. | 1 | alphanumeric |
| ssl_user_id | Converge User ID The user ID with Hosted Payment API User status that can send transaction requests through the terminal. | 15 | alphanumeric |
| ssl_vat_invoice_number | VAT Invoice Number Important: Only applicable to terminals that are set up with the Level 3 terminal option. | 15 | alphanumeric |
| ssl_vendor_app_name | Vendor’s Application Name | 50 | alphanumeric |
| ssl_vendor_app_version | Vendor’s Application Version | 50 | alphanumeric |
| ssl_vendor_id | Vendor id | 20 | alphanumeric |
| ssl_verify | Account Verification Indicator Indicates whether Converge needs to verify the account before generating a token. Valid values:
| 1 | alphanumeric |
| ssl_visapayload | Visa Payload | 4000 | alphanumeric |
| ssl_vision_amount | Vision Amount Amount of vision expenditures. Defaults to 0.00 if not sent. | NA | numeric |
| ssl_vm_mobile_device | Mobile Device Type The type of mobile device from which the transaction originates. Valid values:
| NA | NA |
| ssl_voucher_number | Voucher Clear Number Derived from the merchant’s Food Stamp sales slip. | 15 | alphanumeric |
| ssl_xid | eMPI Transaction ID Unique transaction identifier generated by the Elavon Merchant Plug In (eMPI) engine. | 20 | alphanumeric |