Void - ltvoid

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

The ltvoid transaction removes a loyalty transaction from the Open batch and restores the points or promo code to the card. This transaction is typically used for same day returns or to correct cashier mistakes. This action can only be performed before the batch is settled.

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: ltvoid
ssl_txn_id
46 | alphanumeric | required
Transaction ID
Unique identifier of the Loyalty Card transaction to be removed from the Open batch.

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 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_loyalty_account_balance
 
Account Balance
Available balance on the loyalty card.
ssl_phone
 
Phone Number
 
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_code
 
Promo Code
Promotion code used on the original transaction.
[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.