Sale/Redemption - egcsale

This section describes the message parameters for Gift Card Sale transaction processing, which you can submit using the Hosted Payments, Checkout.js, and XML API integration methods. Refer to the Integration Methods section for more information.

The egcsale transaction deducts the purchase amount from the balance of the Gift Card account.

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: egcsale
ssl_amount
11 | numeric | required
Transaction Amount
The Sale amount that does not include the Tip amount (if applicable).
Format: Number with 2 decimals places
ssl_security_code
6 | numeric | conditional
Card Security Code
Unique verification code assigned to the cardholder's gift card account.
Important: Required if the account is assigned with a security code.
[Card Data]
Use the appropriate card data parameters for the transaction.
ssl_card_number
18 | numeric | conditional
Card Number
Card Number as it appears on the gift card.
Important: Required for hand-keyed transactions.
ssl_exp_date
4 | numeric | conditional
Card's Expiry Date
Date when the card becomes invalid.
Important: Required if ssl_card_number is not null.
Format: MMYY
ssl_track_data
76 | alphanumeric | conditional
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.
Important: Required for swiped transactions.
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.
Important: Required for swiped transactions.
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_ksn
20 | alphanumeric | conditional
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.
Important: Required if using ssl_enc_track_data, ssl_encrypted_track1_data or ssl_encrypted_track2_data.
ssl_token
20 | alphanumeric | conditional
Gift Card Token
Encrypted card data that can replace ssl_card_number.
Important:
  • The token must already be stored.
  • Use only if the terminal is set up with the Tokenization   terminal option.
[Tip Processing]
Use only on terminals that are set up with the Market Segment set to Service.
ssl_tip_amount
11 | numeric | required
Tip or Gratuity Amount
Amount to add or update 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.
[Tokenization]
Use only on terminals that are set up with the Tokenization   terminal option.
ssl_get_token
1 | alphanumeric | optional
Generate Token Indicator
Indicates whether to generate a token when submitting the card data.
Valid values:
  • Y - Authorize transaction and generate token
  • N - Do not generate token (Default)
If set to Y, the following parameters are mandatory:
  • Hand-keyed
    • ssl_card_number
    • ssl_exp_date
  • Swiped
    • ssl_track_data
  • Encrypted Swiped/Contactless
    • ssl_enc_track_data (Ingenico)
    • ssl_encrypted_track1_data (MagTek)
    • ssl_encrypted_track2_data (MagTek)

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 Gift Card Response Codes section for an extensive list of possible returned messages.
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_approval_code
 
Transaction Approval Code
Unique code returned by the credit card processor that indicates the approval status of the transaction.
ssl_card_number
 
Masked Card Number
 
ssl_exp_date
 
Card's Expiry Date
Returned based on merchant setup.
ssl_account_balance
 
Account Balance
Available balance on the gift card.
ssl_email
 
Email Address
The cardholder's or customer's email address. Returned based on merchant setup.
ssl_security_code
 
Card Security Code
Indicates whether a security code was present on the authorization request.
Valid values:
  • TRUE - Security code is present
  • FALSE - Security code is not present
Important: Returned only on terminals that are set up with the Security Code  terminal option.
ssl_amount
 
Total Authorized/Approved Transaction Amount
The amount includes the Tip amount, if submitted in the 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.
[Tokenization]
Returned only if Tokenization  parameters are sent in the request.
ssl_token
 
Gift Card Token
Generated from the card number.
ssl_token_response
 
Token Generation Outcome
A value of SUCCESS indicates Converge generted the token. Other values returned are FAILURE, Action Not Permitted, Invalid Token, Not Permitted, and Acct Verification Failed.
[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.