Purchase - dbpurchase

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

The dbpurchase transaction deducts the purchase amount from the debit cardholder’s checking or savings account, debiting the account immediately.

In this section:

For the entire list of API endpoints, refer to API Endpoints.

Request

Response

Examples

Basic dbpurchase transaction

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_test_mode>False</ssl_test_mode>
    <ssl_transaction_type>dbpurchase</ssl_transaction_type>
    <ssl_dukpt>654321000040002D</ssl_dukpt>
    <ssl_key_pointer>T</ssl_key_pointer>
    <ssl_pin_block>sc1000I</ssl_pin_block>
    <ssl_track_data>%B5121212121212124^CERTIFICATION-MC/ELAVON^491210199999999900876000000?;5121212121212124=4912101876234567?</ssl_track_data>
    <ssl_account_type>0</ssl_account_type>
    <ssl_cvv2cvc2>123</ssl_cvv2cvc2>
    <ssl_amount>10.00</ssl_amount>
    <ssl_tip_amount>2.00</ssl_tip_amount>
    <ssl_transaction_language>EN</ssl_transaction_language>
    <ssl_server>Test User</ssl_server>
    <ssl_shift>Dinner</ssl_shift>
</txn>

Response

<txn>
   <ssl_issuer_response>00</ssl_issuer_response>
   <ssl_last_name/>
   <ssl_company>Elavon</ssl_company>
   <ssl_phone>8524569514</ssl_phone>
   <ssl_card_number>51**********8745</ssl_card_number>
   <ssl_oar_data/>
   <ssl_result>0</ssl_result>
   <ssl_txn_id>290822C4A-5EF3B8D8-9763-46FA-83EE-4E7DDACCA053</ssl_txn_id>
   <ssl_loyalty_program/>
   <ssl_account_type>Checking</ssl_account_type>
   <ssl_approval_code>896565</ssl_approval_code>
   <ssl_account_status/>
   <ssl_email>myemail@elavon.com</ssl_email>
   <ssl_amount>22.00</ssl_amount>
   <ssl_avs_zip>30000</ssl_avs_zip>
   <ssl_txn_time>08/29/2022 02:33:55 PM</ssl_txn_time>
   <ssl_base_amount>20.00</ssl_base_amount>
   <ssl_address2>Second Address</ssl_address2>
   <ssl_card_short_description/>
   <ssl_tip_amount>2.00</ssl_tip_amount>
   <ssl_country>USA</ssl_country>
   <ssl_card_type>DEBITCARD</ssl_card_type>
   <ssl_access_code/>
   <ssl_transaction_type>PURCHASE</ssl_transaction_type>
   <ssl_loyalty_account_balance/>
   <ssl_avs_address>Test Address</ssl_avs_address>
   <ssl_account_balance>0.00</ssl_account_balance>
   <ssl_ps2000_data/>
   <ssl_reference_number>52435</ssl_reference_number>
   <ssl_state>GA</ssl_state>
   <ssl_city>Atlanta</ssl_city>
   <ssl_result_message>APPROVAL</ssl_result_message>
   <ssl_first_name/>
   <ssl_server>TTest Userest User</ssl_server>
   <ssl_tender_amount/>
   <ssl_partner_app_id>AC</ssl_partner_app_id>
</txn>

Cashback

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>dbpurchase</ssl_transaction_type>
   <ssl_pin_block>54C3B8599B753FE5</ssl_pin_block>
   <ssl_ksn>FFFF445566000F000031</ssl_ksn>
   <ssl_key_pointer>T</ssl_key_pointer>
   <ssl_exp_date>1249</ssl_exp_date>
   <ssl_enc_track_data>5A034DF2D8A60C308109EE56BE66479280A49718411AC9F642384CCF1C19C918B31BC1CB707D8EE4F730B8ADFBC26DA61B55F1A76FBFA443177D93262BF698C5BCE6F0EF1DC6016578AC542079C6D17EB0FC870708B461FE3993E9D5855DC9E2</ssl_enc_track_data>
   <ssl_dukpt>FFFF654321005900002C</ssl_dukpt>
   <ssl_account_type>checking</ssl_account_type>
   <ssl_amount>10</ssl_amount>
   <ssl_cashback_amount>3</ssl_cashback_amount>
</txn>

Response

<txn>
   <ssl_surcharge_amount>1.00</ssl_surcharge_amount>
   <ssl_transaction_type>PURCHASE</ssl_transaction_type>
   <ssl_card_number>51**********2124</ssl_card_number>
   <ssl_result>0</ssl_result>
   <ssl_txn_id>080821A3E-2E4E6E35-69AB-4FB1-9127-041A55F15CA1</ssl_txn_id>
   <ssl_account_type>Checking</ssl_account_type>
   <ssl_approval_code>777292</ssl_approval_code>
   <ssl_amount>14.00</ssl_amount>
   <ssl_txn_time>08/08/2021 11:24:12 PM</ssl_txn_time>
   <ssl_account_balance>0.00</ssl_account_balance>
   <ssl_reference_number>00001325</ssl_reference_number>
   <ssl_result_message>APPROVAL</ssl_result_message>
   <ssl_base_amount>10.00</ssl_base_amount>
   <ssl_partner_app_id>01</ssl_partner_app_id>
</txn>

Integration with Loyalty Program Transactions

The Debit Card Purchase transaction can integrate the processing of the following Loyalty Program transactions:

• Lead Inquiry
• Member Inquiry
• Enrollment

Transaction Processing

These steps outline the process of integrating the Lead Inquiry, Member Inquiry, and Enrollment transactions with the Debit Card Purchase transaction.

1. The integrated application sends the payment card to Converge.
2. Converge sends a Lead Inquiry (ltleadinquiry) transaction to Elavon’s loyalty program to verify the payment card’s enrollment status.

   Refer to the Lead Inquiry transaction for information about the appropriate request parameters.

3. Converge receives a response from the Elavon loyalty program. If the Elavon loyalty program recognizes the payment card as a member, it checks for rewards and sends the rewards information (ssl_promo_list) with the new discounted amount (ssl_tender_amount). If the Elavon loyalty program recognized the payment card as not a member, it sends a Join Offer message in the response.
4. Converge sends the Elavon loyalty program response to the integrated application. If the payment card is a member, the integrated application can authorize the Debit Card Purchase transaction using the rewards information and new discounted amount. At this point, the Debit Card Purchase and Loyalty Program transactions are complete. If the payment card is not a member, the integration application prompts (ssl_loyalty_prompt) the cardholder to not enroll, confirm their membership, or enroll.
5. The cardholder selects an option from the prompt displayed by the integrated application. If the cardholder selects to not enroll, the integrated application proceeds with the authorization of the Debit Card Purchase’s original transaction amount. At this point, the Debit Card Purchase and Loyalty Program transactions are complete. If the cardholder confirms their membership, the integrated application sends a Member Inquiry (ltmemberinquiry) transaction. Refer to the Member Inquiry transaction for information about the appropriate request parameters.
6. If the integration application sent a Member Inquiry transaction and the Elavon loyalty program recognizes the payment card as a member, it checks for rewards and sends the rewards information (ssl_promo_list) with the new discounted amount (ssl_tender_amount). The integrated application can then authorize the Debit Card Purchase transaction using the rewards information and new discounted amount. At this point, the Debit Card Purchase and Loyalty Program transactions are complete. If the integrated application sent an Enrollment transaction and the cardholder uses the payment card to enroll, the integrated application sends the Debit Card Purchase transaction with the cardholder’s phone number (ssl_phone) and Enrollment Indicator (ssl_enrollment) (obtained from the ltenrollment transaction), and promotional codes from the ltleadinquiry response. The payment card is charged with purchase amount and enrolled in the loyalty program with a phone number. At this point, the Debit Card Purchase and Loyalty Program transactions are complete. If the integrated application sent an Enrollment transaction and the cardholder uses only their phone number to enroll or a new loyalty card is issued, the Elavon loyalty program enrolls the loyalty card and checks for rewards and responds with the rewards information and new discounted amount. The integrated application can authorize the Debit Card Purchase transaction using the rewards information and new discounted amount. At this point, the Debit Card Purchase and Loyalty Program transactions are complete.

• previousDebit Card Transactions
• nextReturn - dbreturn