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.
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:
For the entire list of API endpoints, refer to API Endpoints.
|Field name||Description||Required||Length||Data type|
Elavon-assigned Converge Account ID (AID).
|Required||6 or 7||numeric|
|Converge User ID|
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
Unique identifier of the Loyalty Card transaction to be removed from the Open batch.
|Transaction Result Message|
Refer to the Loyalty Card Response Codes section for an extensive list of possible returned messages.
Unique identifier of the transaction.
|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
|Transaction Approval Code|
Unique code returned by the credit card processor that indicates the approval status of the transaction.
|Masked Card Number|
|Card’s Expiry Date|
Returned based on merchant setup.
Available balance on the loyalty card.
Description of the merchant’s loyalty program that can be printed on the receipt.
Randomly generated access code that is tied to the primary customer for the account created as part of the loyalty program.
Promotion code used on the original transaction.
|[Error]||Returned only if an error occurs. Refer to the Error Codes section for more information.|
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.
Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
Error name or reason for the error.