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