Swipe Auth Only - emvswipeauthonly

This section describes the message parameters for EMV Swipe Authorization Only transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.

The emvswipeauthonly transaction obtains real-time authorization only for a swiped credit card for an EMV terminal. This transaction covers chip cards in a fallback situation, regular swiped cards, and any non-supported chip cards. This transaction will guarantee that the funds are available on the card and reduce the cardholder‘s limit to buy for only a predetermined amount of time.

To place the transaction in the Open batch, use cccomplete to convert to a Sale transaction or use ccdelete to reverse and restore the funds on the card.

In this section:

Request

ssl_merchant_id
15 | numeric | required
Merchant ID
Elavon-assigned Converge account ID.
ssl_user_id
15 | alphanumeric | required
Converge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
ssl_pin
64 | alphanumeric | required
Terminal ID
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
Important: The ssl_user_id sending the transaction request must be associated with the terminal that will process the request.
ssl_transaction_type
20 | alphanumeric | required
Transaction Type
Value: emvswipeauthonly
ssl_amount
11 | numeric | required
Transaction Amount
The authorization amount that includes the Tip amount (if applicable).
Format: Number with 2 decimals places
[Card Data]
 
ssl_enc_track_data
160 | alphanumeric | conditional
Encrypted Raw Track I and/or II Data
Encrypted Track I and/or II data captured from the card's magnetic stripe when using 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_encrypted_track1_data
160 | alphanumeric | conditional
Encrypted Raw Track I Data
Encrypted Track I data captured from the card's magnetic stripe when using a MagTek encrypting device. The data includes beginning and ending sentinels, card's expiry date, cardholder's first name, and the cardholder's last name.
ssl_encrypted_track2_data
160 | alphanumeric | conditional
Encrypted Raw Track II Data
Encrypted Track II data captured from the card's magnetic stripe when using a MagTek encrypting device.
ssl_pos_mode
2 | numeric | required
POS Device Data Entry Capability
Indicates how the POS device captures card data.
Valid values:
  • 04 - EMV chip-capable (ICC) - Contact only with magnetic stripe
  • 05 - EMV chip-capable (ICC) - Dual interface with magnetic stripe
ssl_entry_mode
2 | numeric | required
Transaction Entry Indicator
Indicates how the track data was captured.
Valid values:
  • 03 - Swiped
  • 04 - Proximity/Contactless
  • 08 - EMV (ICC) Magnetic stripe read when chip failed to read
ssl_ksn
20 | alphanumeric | required
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.
ssl_vm_mobile_source
- | alphanumeric | optional
Mobile Source
Valid values:
  • BBERRY - BlackBerry Mobile Device
  • ADROID - Android Mobile Device
  • ITUNES - Apple Mobile Device
  • WIN8 - Windows WIN8-based Device
  • NOMOB - Non-mobile Device
Important: Required for encrypting devices.
ssl_mobile_id
50 | alphanumeric | optional
Mobile ID
Unique assigned mobile identification number of each mobile device in use as determined by the merchant.
ssl_vendor_id
8 | alphanumeric | optional
Vendor ID
Unique vendor identifier assigned by Elavon.
Important: Required for encrypting devices.
[Invoice Number]
Use only on terminals that are set up with the Invoice Number   credit card payment option.
ssl_invoice_number
25 | alphanumeric | optional
Invoice/Ticket Number
Unique identifier of the invoice or ticket.
[Doing Business As]
Use only on terminals that are set up with the DBA Name   terminal option.
ssl_dynamic_dba
21 | alphanumeric | optional
Doing Business As Name
Merchant-defined descriptors that replace the merchant's business name on credit card statements.
Format: Prefix*Descriptor 
Length: Prefix = 3, 7, or 12,  Asterisk = 1,  Descriptor = 21 - (Prefix + Asterisk)
Example: MANYMAG*BAKERS MONTHLY
[Tip Processing]
Use only on terminals that are set up with the Market Segment set to Service.
ssl_tip_amount
11 | numeric | optional
Tip or Gratuity Amount
Amount to add to the transaction amount.
Format: Number with 2 decimals places
ssl_server
8 | alphanumeric | optional
Server ID
Unique identifier of the clerk, waiter, waitress or cashier.
ssl_shift
4 | alphanumeric | optional
Shift ID
Unique identifier of the time period, course or service type.
[Purchasing Cards]
Use only on terminals that are set up with the Purchasing Card 2   credit card payment option.
ssl_customer_code
17 | alphanumeric | optional
Customer Code or Purchase Order Number
Customer ID or PO number specified in the billing statement of the cardholder.
ssl_salestax
8 | alphanumeric | optional
Sales Tax
Tax amount to add to the purchase or sales amount. For a tax exempt transaction, enter 0.00.
Format: Amount with 2 decimal places.
[Travel Data]
Use only on terminals that are set up with the Travel Data   credit card payment option.
ssl_departure_Date
10 | alphanumeric | optional
Travel Departure Date
Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking.
Format: MM/DD/YYYY
ssl_completion_Date
10 | alphanumeric | optional
Travel Completion Date
Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking.
Format: MM/DD/YYYY

Response

ssl_result
 
Transaction Outcome
An ssl_result = 0 indicates an approved transaction.
An ssl_result not equal to 0 indicates a declined and unauthorized transaction.
ssl_result_message
 
Transaction Result Message
Refer to the EMV Card Response Codes section for an extensive list of possible returned messages.

Important: When the Chip sends a *decline by card*,  submit an emvreverse transaction to reverse an approved authorization.
ssl_response_code
 
Authorization Result Code
Refer to the EMV Card Response Codes section for an extensive list of possible returned response codes.
ssl_approval_code
 
Transaction Approval Code
Unique code returned by the credit card processor that indicates the approval status of the transaction.
ssl_txn_id
 
Transaction ID
Unique identifier of the transaction.
ssl_txn_time
 
Processing Date and Time
Indicates when Converge processed the transaction.
Format: MM/DD/YYYY hh:mm:ss AM/PM
Example: 03/18/2010 10:34:10 AM
ssl_card_number
 
Masked Card Number
Converge only returns the first 2 or last 4 digits of the regular PAN.
ssl_card_scheme
 
Association Long Name
As defined in the Converge Bank Identification Number (BIN) file.
ssl_amount
 
Total Authorized/Approved Transaction Amount
The amount includes the Tip amount, if submitted in the request.
[Invoice Number]
Returned only if Invoice Number  parameters are sent in the request.
ssl_invoice_number
 
Invoice Number
The invoice number or ticket number sent in the original request.
[Tip Processing]
Returned only if Tip  parameters are sent in the request.
ssl_base_amount
 
Base Amount
Original transaction amount sent in the request. Returned based on the terminal setup.
ssl_tip_amount
 
Tip Amount
Added or updated tip or gratuity amount. Returned based on the terminal setup.
ssl_server
 
Server ID
Server identifier sent in the request. Returned based on the terminal setup.
ssl_shift
 
Shift
Shift information sent in the request. Returned based on the terminal setup.
[Error]
Returned only if an error occurs. Refer to the Error Codes section for more information.
errorCode
 
Error Code
Typically, when the transaction failed validation or the request is incorrect. This will prevent the transaction from going to authorization. This is a numeric field.
errorMessage
 
Error Message
Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
errorName
 
Error Name
Error name or reason for the error.