Billing and Invoicing Integration Guide
Magento Guide
Enrollment - ltenrollment
This section describes the message parameters for Loyalty Card Enrollment transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.
The ltenrollment transaction enrolls and activates a loyalty card.
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: ltenrollment |
ssl_phone 10 | numeric | required | Phone Phone number on the cardholder's / customer's account or billing address. Allows access to the loyalty card information for future transactions when the loyalty card is unavailable. Important: Must not include spaces or dashes. |
ssl_enrollment 2 | numeric | required | Enrollment Indicator Indicates how to enroll in the loyalty program. Valid values:
|
ssl_amount 11 | numeric | optional | Transaction Amount Purchase amount is not necessary for enrollment transactions. Defaults to 0.00 if null. Format: Number with 2 decimals places |
ssl_promo_code 10 | alphanumeric | optional | Promotion Code The cardholder can only use the promo code once. |
ssl_issue_points 1 | alphanumeric | optional | Accrue Points Indicates whether to accrue points for the current transaction. Valid values:
|
[Card Data] | Use the appropriate card data parameters for the transaction. |
ssl_loyalty_card_number 19 | numeric | conditional | Loyalty Card Number Unique identifier of the loyalty card. Important:
|
ssl_loyalty_exp_date 4 | numeric | conditional | Loyalty Card's Expiry Date Date when the card becomes invalid. Important:
|
ssl_loyalty_track_data 76 | alphanumeric | conditional | 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 name, and the cardholder's last name. Important: Required if ssl_enrollment = 02. |
ssl_enc_loyalty_track_data 160 | alphanumeric | conditional | Encrypted Track Data Track data captured from the card's magnetic stripe or an Ingenico encrypting device. |
ssl_encrypted_loyalty_track1_data 160 | alphanumeric | conditional | Encrypted Loyalty Track I Data Track I data captured from a MagTek encrypting device. |
ssl_encrypted_loyalty_track2_data 160 | alphanumeric | conditional | Encrypted Loyalty Track II Data Track II data captured from a MagTek encrypting device. |
ssl_ksn 20 | alphanumeric | conditional | 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. Important: Required if using:
|
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_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_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 ssl_promo_code, ssl_promo_code_name, ssl_promo_code_description, and ssl_promo_code_issue_points. |
[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
error_outline
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
<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>ltenrollment</ssl_transaction_type>
<ssl_amount>100.00</ssl_amount>
<ssl_phone>999999999</ssl_phone>
<ssl_enrollment>03</ssl_enrollment>
<ssl_promo_code>1002</ssl_promo_code>
<ssl_issue_points>N</ssl_issue_points>
</txn>Response
<txn>
<ssl_approval_code>476928</ssl_approval_code>
<ssl_enrollment>03</ssl_enrollment>
<ssl_card_type>LOYALTY</ssl_card_type>
<ssl_loyalty_program>Spend $50-Get $10Off</ssl_loyalty_program>
<ssl_account_balance>100</ssl_account_balance>
<ssl_result_message>APPROVAL</ssl_result_message>
<ssl_result>0</ssl_result>
<ssl_txn_id>AA48439-7315C852-44E4-45CF-A0F4-13FCD27BB7C2</ssl_txn_id>
<ssl_issue_points>N</ssl_issue_points>
<ssl_txn_time>04/17/2014 10:44:33 AM</ssl_txn_time>
<ssl_promo_list>
<ssl_promo_product>
<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>
</ssl_promo_product>
</ssl_promo_list>
</txn>