Lead Inquiry - ltleadinquiry
This section describes the message parameters for Loyalty Card Lead Inquiry transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.
The ltleadinquiry transaction determines if a payment card is enrolled in the loyalty program and has any current offers or rewards available for redemption.
If the payment card is enrolled in the loyalty program and has any curreny offers or rewards available, the cardholder can opt to use the rewards towards the current sale. In this case, a new Transaction Amount is calculated.
If the payment card is not enrolled and the cardholder wishes to enroll, the application can link the card using a Credit Card Sale (ccsale).
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: ltleadinquiry | Required | 20 | alphanumeric |
ssl_amount | Transaction Amount The Sale amount that includes the Net and Sales Tax amounts. Format: Number with 2 decimal places | Required | 11 | numeric |
| [Card Data] | Use the appropriate card data parameters for the transaction. | |||
ssl_card_number | Card Number Card Number as it appears on the credit card. Required for hand-keyed transactions. | Conditional | 18 | numeric |
ssl_exp_date | Card’s Expiry Date Date when the card becomes invalid. Required if ssl_card_number is not null.
Format: MMYY | 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 and contactless 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_enc_track_data_format | Encrypted Raw Track I and/or II Data Format Format of the track data captured from the card’s magnetic stripe. Valid value: ROAM_GENERIC_TDES_EMVRequired if card is read from a ROAM device. | Conditional | - | - |
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_card_number | Masked Card Number Converge only returns the first 2 or last 4 digits of the regular PAN. |
ssl_account_status | Account Status Valid values:
|
ssl_amount | Total Authorized/Approved Transaction Amount Return based on merchant setup. |
ssl_tender_amount | New Discounted Amount Indicates the transaction amount less the discount for the offer, if available. |
ssl_account_balance | Account Balance Available balance on the credit card. |
ssl_loyalty_prompt | Loyalty Prompt Determines if the point-of-sale application should prompt the customer to enroll. Valid values:
|
ssl_loyalty_account_balance | Account Balance Available balance on the loyalty card. |
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_issue_points | Accrue Points Indicates whether points are accrued for the current transaction. Valid values:
|
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. |
Examples
error_outline
important
- In these examples, 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.
Loyalty Lead Request with Some Rewards in the Card
The response has indicated that this particular card has been previously enrolled and there are some rewards in the card. The loyalty prompt indicates that the cardholder should not be prompted to enroll.
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>ltleadinquiry</ssl_transaction_type>
<ssl_amount>1</ssl_amount>
<ssl_track_data>;0000000000000000=0000000000000000000?</ssl_track_data>
</txn>
Response
<txn>
<ssl_user_id>my_user_id</ssl_user_id>
<ssl_card_type>LOYALTY</ssl_card_type>
<ssl_transaction_type>ltleadinquiry</ssl_transaction_type>
<ssl_txn_time>04/17/2014 09:05:38 AM</ssl_txn_time>
<ssl_account_status>1</ssl_account_status>
<ssl_loyalty_prompt>N</ssl_loyalty_prompt>
<ssl_promo_code>1002</ssl_promo_code>
<ssl_promo_code_name>Join-Get 10% Off</ssl_promo_code_name>
<ssl_promo_code_description>SAVE 10%</ssl_promo_code_description>
<ssl_promo_code_issue_points>N</ssl_promo_code_issue_points>
</txn>
Loyalty Lead Request with Rewards Associated to the Card
The response has indicated that this particular card has been previously enrolled and has rewards associated to it. Once it is determined that a payment card is linked to a loyalty program and an existing offer is available with a new discounted amount. The cardholder may opt to use it.
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>ltleadinquiry</ssl_transaction_type>
<ssl_amount>1</ssl_amount>
<ssl_track_data>;0000000000000000=0000000000000000000?</ssl_track_data>
</txn>
Response
<txn>
<ssl_approval_code>QVI418</ssl_approval_code>
<ssl_cvv2_response>U</ssl_cvv2_response>
<ssl_enrollment></ssl_enrollment>
<ssl_exp_date>0115</ssl_exp_date>
<ssl_account_balance>1.00</ssl_account_balance>
<ssl_departure_date></ssl_departure_date>
<ssl_result_message>APPROVAL</ssl_result_message>
<ssl_salestax></ssl_salestax>
<ssl_invoice_number></ssl_invoice_number>
<ssl_units></ssl_units>
<ssl_promo_code></ssl_promo_code>
<ssl_amount>1.00</ssl_amount>
<ssl_txn_id>AA4D3F5-CD5C7BF9-583B-4B5B-BA6D-5592D1538B7B</ssl_txn_id>
<ssl_result>0</ssl_result>
<ssl_card_number>00**********0000</ssl_card_number>
<ssl_completion_date></ssl_completion_date>
<ssl_issue_points></ssl_issue_points>
<ssl_txn_time>04/16/2014 03:49:41 PM</ssl_txn_time>
<ssl_customer_code></ssl_customer_code>
<ssl_avs_response></ssl_avs_response>
</txn>