Balance Inquiry - ltinquiry
This section describes the message parameters for Loyalty Card Add Points transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.
The ltinquiry transaction gets the current balance and any current rewards or offers available for the loyalty card.
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: ltinquiry | Required | 20 | alphanumeric |
ssl_phone | Phone Return points using the phone number linked to the loyalty card. Format: Accepts dashes | Optional | 20 | numeric |
| [Card Data] | Use the appropriate card data parameters for the transaction. | |||
ssl_loyalty_card_number | Loyalty Card Number Inquire the current balance and current rewards or offers 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. Required if ssl_loyalty_card_number is not null.
Format: MMYY | 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_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:
| 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_loyalty_account_balance | Account Balance Available balance on the loyalty card. |
ssl_amount | Transaction Amount Returned based on merchant setup. |
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_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:
|
| [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. |