Swipe Sale - emvswipesale

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

The emvswipesale transaction obtains real-time Sale authorization for a swiped credit or debit card for an EMV terminal. This transaction covers chip cards in a fallback situation, regular swiped cards, and any non-supported chip cards. Converge enters the transaction into the Unsettled batch after obtaining the authorization.

error_outline
note
  • An emvchipupdatetxn transaction must be sent once an emvchipsale has been completed and the Chip card has returned additional data.
  • POS system will need to update the chip or device with the Issuer Script received from the authorization.

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: emvswipesale
ssl_amount
11 | numeric | required
Transaction Amount
The Sale amount that includes the Sales Tax amount and Tip amount (if applicable).
Format: Number with 2 decimals places
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
ssl_surcharge_amount
 
Surcharge Amount
The fee that the merchant charges for the transaction as a cost for doing business.
Important: Only applicable to terminals that are set up with the Surcharge debit payment option.
Format: Number with 2 decimal 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_enc_track_data_format
- | - | conditional
Encrypted Raw Track I and/or II Data Format
Format of the track data captured from the card's magnetic stripe.
Valid value: ROAM_GENERIC_TDES_EMV
Important: Required if card is read from a ROAM device.
ssl_card_type
10 | alphanumeric | optional
Card Type
Valid values:
  • Credit (default if parameter is null)
  • Debit
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_dukpt
20 | - | conditional
DUKPT
Value used to encrypt the PIN of the cardholder and returned by the PIN Pad.
Important: Required if ssl_card_type = Debit.
ssl_pin_block
16 | - | conditional
Encrypted PIN Block
The encrypted personal identification number to authenticate ownership of the card.
Important: Required if ssl_card_type = Debit.
ssl_account_type
1 | numeric | conditional
Bank Deposit Account Type
Valid values:
  • 0 - Checking
  • 1 - Saving
Important: Required if ssl_card_type = Debit.
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
Note: You can modify the tip amount after approval by using the ccupdatetip transaction.
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
[Optional Fields]
 
ssl_partial_auth_indicator
1 | numeric | optional
Partial Authorization Indicator
Indicates whether the integrated application supports partial authorization or approval.
Valid values:
  • 0 - Partial authorization not supported (Default)
  • 1 - Partial authorization supported
[Interac]
Canadian Debit Transaction
ssl_sys_trace_audit_no
6 | - | optional
System Trace Audit Number
Used by the POS to uniquely identify the transaction to the host. This is used in the MAC calculation.
ssl_processing_code
6 | numeric | optional
Processing Code
Type of Canadian debit transaction.
Valid values:
  • 000000 - Debit Purchase from the Default Account (Flash Only)
  • 001000 - Debit Purchase from Savings
  • 002000 - Debit Purchase from Checking
  • 091000 - Debit Purchase with Cashback from Savings
  • 092000 - Debit Purchase with Cashback from Checking
  • 200000 - Debit Return from the Default Account (Flash Only)
  • 200010 - Debit Return from Savings
  • 200020 - Debit Return from Checking
  • 220000 - Void of a Debit Purchase from the Default Account (Flash Only)
  • 220010 - Void of a Debit Purchase from Savings
  • 220020 - Void of a Debit Purchase from Checking
  • 020000 - Void of a Debit Return from the Default Account (Flash Only)
  • 021000 - Void of a Debit Return from Savings
  • 022000 - Void of a Debit Return from Checking
ssl_mac_value
8 | hex | optional
Message Authentication Code
Verifies that the Canadian debit message was not altered when transferred over a telecommunications network.

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_update_emv_keys
 
Update EMV Keys Indicator
Indicates whether an EMV key exchange is needed because the Issuer keys have changed.
Valid values:
  • Y - Perform EMV key exchange
  • N - Do not perform EMV key exchange
Important: If set to Y, perform an emvkeyexchange transaction.
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_account_type
 
Account Type on File
Valid values:
  • Checking
  • Savings
  • Default
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
 
Transaction 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_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.
[Interac]
Canadian Debit Transaction
ssl_debit_response_code
 
Debit Authorization Result Code
Returned by the debit gateway for Canadian debit authorization attempt.
ssl_mac_value
 
Message Authentication Code Value
Verifies that the Canadian debit message was not altered when transferred over a telecommunications network.
ssl_sys_trace_audit_no
 
System Trace Audit Number
Used by the POS to uniquely identify the transaction to the host. This is used in the MAC calculation.
ssl_processing_code
 
Transaction Type
&nbsp
ssl_retrieval_reference_number
 
Reference Number
Assigned by Elavon.
[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.