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 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
Value:egcsale
Required20alphanumeric
ssl_amountTransaction Amount
The Sale amount that does not include the Tip amount (if applicable).
Format: Number with 2 decimals places
Required11numeric
ssl_security_codeCard Security Code
Unique verification code assigned to the cardholder’s gift card account.
Required if the account is assigned with a security code.
Conditional6numeric
[Card Data]Use the appropriate card data parameters for the transaction.
ssl_card_numberCard Number
Card Number as it appears on the gift card.
Required for hand-keyed transactions.
Conditional18numeric
ssl_exp_dateCard’s Expiry Date
Date when the card becomes invalid.
Format: MMYY
Required if ssl_card_number is not null.
Conditional4numeric
ssl_track_dataRaw 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.
Required for swiped transactions.
Conditional76alphanumeric
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.

important

Required for swiped transactions.

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_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.
Required if using ssl_enc_track_data, ssl_encrypted_track1_data or ssl_encrypted_track2_data.
Conditional20alphanumeric
ssl_tokenGift 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.
Conditional20alphanumeric
[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
Required11numeric
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
[Tokenization]Use only on terminals that are set up with the Tokenization terminal option.
ssl_get_tokenGenerate 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)
Optional1alphanumeric

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 Gift Card Response Codes section for an extensive list of possible returned messages.
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_approval_codeTransaction Approval Code
Unique code returned by the credit card processor that indicates the approval status of the transaction.
ssl_card_numberMasked Card Number
ssl_exp_dateCard’s Expiry Date
Returned based on merchant setup.
ssl_account_balanceAccount Balance
Available balance on the gift card.
ssl_emailEmail Address
The cardholder’s or customer’s email address. Returned based on merchant setup.
ssl_security_codeCard 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_amountTotal 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_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.
[Tokenization]Returned only if Tokenization parameters are sent in the request.
ssl_tokenGift Card Token
Generated from the card number.
ssl_token_responseToken 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.
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.