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

Field name Description Required Length Data type
ssl_merchant_id Merchant ID
Elavon-assigned Converge account ID.
Required 15 numeric
ssl_user_id Converge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
Required 15 alphanumeric
ssl_pin Terminal ID
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
error_outline

important

The ssl_user_id sending the transaction request must be associated with the terminal that will process the request.

Required 64 alphanumeric
ssl_transaction_type Transaction Type
Value: egcsale
Required 20 alphanumeric
ssl_amount Transaction Amount
The Sale amount that does not include the Tip amount (if applicable).
Format: Number with 2 decimals places
Required 11 numeric
ssl_security_code Card Security Code
Unique verification code assigned to the cardholder's gift card account.
error_outline

important

Required if the account is assigned with a security code.

Conditional 6 numeric
[Card Data] Use the appropriate card data parameters for the transaction.
ssl_card_number Card Number
Card Number as it appears on the gift card.
error_outline

important

Required for hand-keyed transactions.

Conditional 18 numeric
ssl_exp_date Card's Expiry Date
Date when the card becomes invalid.
Format: MMYY
error_outline

important

Required if ssl_card_number is not null.

Conditional 4 numeric
ssl_track_data 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 and last name.
error_outline

important

Required for swiped transactions.

Conditional 76 alphanumeric
ssl_enc_track_data 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 and last name.
Conditional 160 alphanumeric
ssl_encrypted_track1_data 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 and last name.
error_outline

important

Required for swiped transactions.

Conditional 160 alphanumeric
ssl_encrypted_track2_data Encrypted Raw Track II Data
Encrypted Track II data captured from the card's magnetic stripe when using a MagTek encrypting device.
Conditional 160 alphanumeric
ssl_ksn 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.
error_outline

important

Required if using ssl_enc_track_data, ssl_encrypted_track1_data or ssl_encrypted_track2_data.

Conditional 20 alphanumeric
ssl_token Gift Card Token
Encrypted card data that can replace ssl_card_number.
error_outline

important

The token must already be stored.
Use only if the terminal is set up with the Tokenization terminal option.

Conditional 20 alphanumeric
[Tip Processing] Use only on terminals that are set up with the Market Segment set to Service.
ssl_tip_amount Tip or Gratuity Amount
Amount to add or update to the transaction amount.
Format: Number with 2 decimal places
Required 11 numeric
ssl_server Server ID
Unique identifier of the clerk, waiter, waitress or cashier.
Optional 8 alphanumeric
ssl_shift Shift ID
Unique identifier of the time period, course or service type.
Optional 4 alphanumeric
[Tokenization] Use only on terminals that are set up with the Tokenization terminal option.
ssl_get_token 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)
Optional 1 alphanumeric

Response

Field name Description
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
error_outline

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 generated 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.