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

Field nameDescriptionRequiredLengthData type
ssl_merchant_idMerchant ID
Elavon-assigned Converge account ID.
Required15numeric
ssl_user_idConverge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
Required15alphanumeric
ssl_pinTerminal ID
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
The ssl_user_id sending the transaction request must be associated with the terminal that will process the request.
Required64alphanumeric
ssl_transaction_typeTransaction Type
Valid value:emvswipesale
Required20alphanumeric
ssl_amountTransaction Amount
The Sale amount that includes the Sales Tax amount and Tip amount (if applicable).
Format: Number with 2 decimal places
Required11numeric
[Card Data]
ssl_enc_track_dataEncrypted Raw Track I and/or II Data
Encrypted Track I and/or II data captured from the card’s magnetic stripe when using an Ingenico encrypting device. The data includes beginning and ending sentinels, card’s expiry date, cardholder’s first and last name.
Conditional160alphanumeric
ssl_encrypted_track1_dataEncrypted 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 and last name.
Conditional160alphanumeric
ssl_encrypted_track2_dataEncrypted Raw Track II Data
Encrypted Track II data captured from the card’s magnetic stripe when using a MagTek encrypting device.
Conditional160alphanumeric
ssl_pos_modePOS 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
Required2numeric
ssl_entry_modeTransaction 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
Required2numeric
ssl_ksnKey Serial Number
Unique identifier generated from the swiped payment card and returned by the encrypting device. The KSN encrypts the PAN data through the DUKPT method.
Required20alphanumeric
ssl_vm_mobile_sourceMobile Source
Valid values:
- BBERRY - BlackBerry Mobile Device
- ADROID - Android Mobile Device
- ITUNES - Apple Mobile Device
WIN8 - Windows WIN8-based Device
- NOMOB - Non-mobile Device
Required for encrypting devices.
Optional-alphanumeric
ssl_mobile_idMobile ID
Unique assigned mobile identification number of each mobile device in use as determined by the merchant.
Optional50alphanumeric
ssl_vendor_idVendor ID
Unique vendor identifier assigned by Elavon.
Required for encrypting devices.
Optional8alphanumeric
[Invoice Number]Use only on terminals that are set up with the Invoice Number credit card payment option
ssl_invoice_numberInvoice/Ticket Number
Unique identifier of the invoice or ticket.
Optional25alphanumeric
[Doing Business As]Use only on terminals that are set up with the DBA Name terminal option.
ssl_dynamic_dbaDoing 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
Optional21alphanumeric
[Tip Processing]Use only on terminals that are set up with the Market Segment set to Service
ssl_tip_amountTip or Gratuity Amount
Amount to add or update to the transaction amount.
Format: Number with 2 decimal places
Optional11numeric
ssl_serverServer ID
Unique identifier of the clerk, waiter, waitress or cashier.
Optional8alphanumeric
ssl_shiftShift ID
Unique identifier of the time period, course or service type.
Optional4alphanumeric
[Purchasing Cards]Use only on terminals that are set up with the Purchasing Card 2 credit card payment option
ssl_customer_codeCustomer Code or Purchase Order Number
Customer ID or PO number specified in the billing statement of the cardholder.
Optional17alphanumeric
ssl_salestaxSales 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.
Optional8alphanumeric
[Travel Data]Use only on terminals that are set up with the Travel Data credit card payment option.
ssl_departure_DateTravel Departure Date
Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking.
Format: MM/DD/YYYY
Optional10alphanumeric
ssl_completion_DateTravel Completion Date
Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking.
Format: MM/DD/YYYY
Optional10alphanumeric

Response

Field nameDescription
ssl_resultTransaction Outcome
An ssl_result = 0 indicates an approved transaction.
An ssl_result not equal to 0 indicates a declined and unauthorized transaction.
ssl_result_messageTransaction Result Message
Refer to the Debit 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_codeAuthorization Result Code
Refer to the EMV Card Response Codes section for an extensive list of possible returned response codes.
ssl_approval_codeTransaction Approval Code
Unique code returned by the credit card processor that indicates the approval status of the transaction.
ssl_txn_idTransaction ID
Unique identifier of the transaction.
ssl_txn_timeProcessing 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_numberMasked Card Number
Converge only returns the first 2 or last 4 digits of the regular PAN.
ssl_card_schemeAssociation Long Name
As defined in the Converge Bank Identification Number (BIN) file.
ssl_amountTransaction Amount
The total transaction amount that may include the Surcharge or Cashback amount.
[Invoice Number]Returned only if Invoice Number parameters are sent in the request.
ssl_invoice_numberInvoice 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_amountBase Amount
Original transaction amount sent in the request. Returned based on the terminal setup.
ssl_tip_amountTip Amount
Added or updated tip or gratuity amount. Returned based on the terminal setup.
ssl_serverServer ID
Server identifier sent in the request. Returned based on the terminal setup.
ssl_shiftShift
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.
errorCodeError 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.
errorMessageError Message
Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
errorNameError Name
Error name or reason for the error.