Redemption - ltredeem

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

The ltredeem transaction redeems points.

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.	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. 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:`ltredeem`	Required	20	alphanumeric
`ssl_phone`	Phone Redeem the available points using the phone number linked to the loyalty card. Format: Must not include spaces or dashes.	Optional	10	numeric
`ssl_amount`	Transaction Amount Sale Amount Format: Number with 2 decimal places	Required	11	numeric
`ssl_promo_code`	Promotion Code The cardholder can only use the promo code once.	Required	10	alphanumeric
`ssl_security_code`	Card Security Code Unique verification code assigned to the cardholder’s loyalty 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_loyalty_card_number`	Loyalty Card Number Redeem the available points using the unique identifier of the loyalty card. Required for hand-keyed transactions.	Conditional	19	numeric
`ssl_loyalty_exp_date`	Loyalty Card’s Expiry Date Date when the card becomes invalid. Format: MMYY Required if `ssl_loyalty_card_number` is not null. Defaults to 1249 if parameter is not null.	Optional	4	numeric
`ssl_loyalty_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 if loyalty card is available for swipe transactions.	Conditional	76	alphanumeric
`ssl_enc_loyalty_track_data`	Encrypted Track Data Track data captured from the card’s magnetic stripe or an Ingenico encrypting device.	Conditional	160	alphanumeric
`ssl_encrypted_loyalty_track1_data`	Encrypted Loyalty Track I Data Track I data captured from a MagTek encrypting device.	Conditional	160	alphanumeric
`ssl_encrypted_loyalty_track2_data`	Encrypted Loyalty Track II Data Track II data captured from 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. Required if using: `ssl_enc_loyalty_track_data` `ssl_encrypted_loyalty_track1_data` `ssl_encrypted_loyalty_track2_data`	Conditional	20	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 Loyalty 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_loyalty_card_number`	Masked Card Number
`ssl_loyalty_exp_date`	Card’s Expiry Date Returned based on merchant setup.
`ssl_phone`	Phone Number
`ssl_loyalty_account_balance`	Account Balance Available balance on the loyalty card.
`ssl_amount`	Transaction Amount Returned based on merchant setup.
`ssl_loyalty_program`	Loyalty Program Description of the merchant’s loyalty program that can be printed on the receipt.
`ssl_access_code`	Access Code Randomly generated access code that is tied to the primary customer for the account created as part of the loyalty program.
`ssl_promo_list`	Promotion List This contains a list of all promo products; the data for each promo product will be nested and embedded between beginning and ending elements: `ssl_promo_product` up to 5 promo products. Each promo product (`ssl_promo_product`) will contain: `ssl_promo_code` `ssl_promo_code_name` `ssl_promo_code_description` `ssl_promo_code_issue_points`
`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 Returned only on terminals that are set up with the Security Code terminal option.
`ssl_issue_points`	Accrue Points Indicates whether points are accrued for the current transaction. Valid values: `Y` - Points accrued `N` - Points not accrued
[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>ltredeem</ssl_transaction_type>
    <ssl_amount>1</ssl_amount>
    <ssl_promo_code>1002</ssl_promo_code>
    <ssl_loyalty_card_number>0000000000000000</ssl_loyalty_card_number>
    <ssl_loyalty_exp_date>1249</ssl_loyalty_exp_date>
</txn>

Response

<txn>
    <ssl_approval_code>980012</ssl_approval_code>
    <ssl_promo_code>1002</ssl_promo_code>
    <ssl_card_type>LOYALTY</ssl_card_type>
    <ssl_exp_date>1249</ssl_exp_date>
    <ssl_txn_id>AA4D3F5-76D519AF-3A8F-4674-ADD7- C917713D7206</ssl_txn_id>
    <ssl_result>0</ssl_result>
    <ssl_card_number>00**********0000</ssl_card_number>
    <ssl_account_balance>310000</ssl_account_balance>
    <ssl_issue_points/>
    <ssl_txn_time>04/17/2014 09:39:08 AM</ssl_txn_time>
    <ssl_result_message>APPROVAL</ssl_result_message>
</txn>