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:

For the entire list of API endpoints, refer to API Endpoints.

Request

Field name	Description	Required	Length	Data type
`ssl_merchant_id`	Merchant ID Elavon-assigned Converge Account ID (AID).	Required	6 or 7	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. 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. 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. Required for hand-keyed transactions.	Conditional	18	numeric
`ssl_exp_date`	Card’s Expiry Date Date when the card becomes invalid. Format: MMYY 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. 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_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. Required if using `ssl_enc_track_data`.	Conditional	20	alphanumeric
`ssl_token`	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.	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`	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 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_provider`	Credit Card Token Provider This code indicates the provider for the token. This value is also visible in the Converge UI. Valid values: P for legacy tokens. V for Voltage tokens
`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.

Example

important

In this example, you will have to change the data values, such as my_merchant_id, my_user_id, my_pin, and transaction data to match your Converge account and meet the needs of your website.
Code samples provided are for demonstration only and should not be used for live transactions. All sensitive merchant data, including transaction amounts and your Converge credentials, should be placed in server side code.

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>egcsale</ssl_transaction_type>
    <ssl_amount>10</ssl_amount>
    <ssl_egc_tender_type>0</ssl_egc_tender_type>
    <ssl_card_number>41**********1111</ssl_card_number>
    <ssl_exp_date>1224</ssl_exp_date>
    <ssl_security_code>1234</ssl_security_code>
</txn>

Cash Advance

Apple Pay

Magento Guide

Sale/Redemption - egcsale

Request

Response

Example

Request