Return - dbreturn
This section describes the message parameters for Debit Card Refund transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.
The dbreturn transaction refunds the transaction amount to the debit cardholder’s checking or savings account and reflects immediately the balance in the account.
error_outline
note
The merchant must contact Elavon to make sure that Debit refunds are enabled for the terminal.
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 Valid value: dbreturn | Required | 20 | alphanumeric |
ssl_amount | Transaction Amount The base amount that does not include the Cashback or Tip amount. The system computes for the total amount to send for authorization. Format: Number with 2 decimals places | Required | 11 | numeric |
ssl_original_date | Original Transaction Date The date of the original Debit Purchase ( dbpurchase) transaction.Format: MMDDYY | Required | 6 | numeric |
ssl_original_time | Original Transaction Time The time of the original Debit Purchase ( dbpurchase) transaction.Format: HHMMSS | Required | 6 | numeric |
ssl_reference_number | Transaction Reference Number Unique transaction reference number returned in the authorization response message of the original Debit Purchase ( dbpurchase) transaction. | Required | 8 | numeric |
| [Card Data] | ||||
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 | 76 | alphanumeric |
ssl_account_type | Bank Deposit Account Type Valid values:
| Required | 1 | numeric |
| [PIN Pad] | Values returned by the PIN Pad device. | |||
ssl_dukpt | DUKPT Value used to encrypt the PIN of the cardholder. | Required | 20 | - |
ssl_key_pointer | Triple-DES DUKPT Pointer Indicates the encryption key used on US debit transactions. Valid value: T - Triple-DES DUKPT | Required | 1 | alphanumeric |
ssl_pin_block | Encrypted PIN Block The encrypted personal identification number entered by the debit cardholder to authenticate ownership of the card. | Required | 16 | - |
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 Debit 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/2022 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_reference_number | Transaction Reference Number |
ssl_card_number | Masked Card Number Converge only returns the first 2 or last 4 digits of the regular PAN. |
ssl_exp_date | Card’s Expiry Date Returned based on merchant setup. |
ssl_amount | Transaction Amount The refund amount returned to the cardholder’s account. |
ssl_email | Email Address The cardholder’s or customer’s email address. Returned based on merchant setup. |
| [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 all of 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.
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>dbreturn</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>0.50</ssl_amount>
<ssl_transaction_language>EN</ssl_transaction_language>
<ssl_reference_number>8504</ssl_reference_number>
<ssl_original_date>052517</ssl_original_date>
<ssl_original_time>145447</ssl_original_time>
</txn>
Response
<txn>
<ssl_transaction_type>RETURN</ssl_transaction_type>
<ssl_card_number>41**********9990</ssl_card_number>
<ssl_result>1</ssl_result>
<ssl_txn_id>310822OE-834B346E-D1E4-4900-B8F2-A4C56E3D08C1</ssl_txn_id>
<ssl_account_type>Saving</ssl_account_type>
<ssl_approval_code></ssl_approval_code>
<ssl_amount>1.00</ssl_amount>
<ssl_txn_time>08/31/2022 06:17:19 PM</ssl_txn_time>
<ssl_account_balance>0.00</ssl_account_balance>
<ssl_reference_number>65839</ssl_reference_number>
<ssl_result_message>EXCEEDS AMT LMT</ssl_result_message>
<ssl_card_short_description>VISA</ssl_card_short_description>
<ssl_card_type>DEBITCARD</ssl_card_type>
<ssl_partner_app_id>AC</ssl_partner_app_id>
</txn>