Void - dbvoid

Voiding a transaction is primarily useful for PINless bill pay transactions. Besides this primary case, voiding is usable on other debit transactions that have not settled but you want to cancel.

In this section:

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

Requirements

dbvoid is only usable on terminals with the following settings:

  • Region set to USA
  • Debit transactions enabled

If you would like to enable these settings on your terminal, please contact Elavon Software Technical Support.

Request

Field nameDescriptionRequiredLengthData type
ssl_merchant_idMerchant ID
Elavon-assigned Converge Account ID (AID).
Required6 or 7numeric
ssl_user_idConverge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
Required15alphanumeric
ssl_pinTerminal 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.
Required64alphanumeric
ssl_transaction_typeTransaction Type
Valid value:  dbvoid
Required20alphanumeric
ssl_txn_idTransaction ID
Unique identifier of the approved or denied transaction.
Required46alphanumeric
[Optional Fields]
ssl_lane_numberLane Number
A unique identifier for point of sale devices that can be passed to satisfy Mastercard’s unique Terminal ID requirement
Optional8numeric

Response

Field nameDescription
ssl_card_numberMasked Card Number
Converge only returns the first 2 or last 4 digits of the regular PAN, or the last 4 digits of the actual card number if it is an association token (example, ApplePay).
ssl_resultTransaction Outcome
An ssl_result = 0 indicates an approved transaction.
An ssl_result not equal to 0 indicates a declined and unauthorized transaction.
ssl_txn_idTransaction ID
Unique identifier of the transaction.
ssl_account_typeBank Deposit Account Type
Valid values:
  • 0 - Checking
  • 1 - Savings
ssl_approval_codeTransaction Approval Code
Unique code returned by the credit card processor that indicates the approval status of the transaction.
ssl_amountTotal Authorized/Approved Transaction Amount
Return based on merchant setup.
ssl_txn_timeProcessing 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_base_amountBase Amount
Original transaction amount sent in the request. Returned based on the terminal setup.
ssl_card_typePayment Type
Valid value:  DEBITCARD
ssl_transaction_typeTransaction Type
Valid value:  VOID
ssl_account_balanceAccount Balance
Available balance on the credit card.
ssl_reference_numberTransaction Reference Number
ssl_result_messageTransaction Result Message
Refer to the Debit Card Response Codes section for an extensive list of possible returned messages.
ssl_issuer_responseOriginal Issuer Response
The issuer response returned during the authorization attempt.
An ssl_issuer_response = 00 indicates success.
An ssl_issuer_response not equal to 00 indicates a decline or failure.
[Error]Returned only if an error occurs. Refer to the Error Codes section for more information.
errorCodeError 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.
errorMessageError Message
Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
errorNameError Name
Error name or reason for the error.

Examples

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>dbvoid</ssl_transaction_type>
    <ssl_txn_id>060320MB-2B27A92F-3998-47C3-9394-219272D9E93B</ssl_txn_id>
</txn>

Response

<txn>
    <ssl_issuer_response>00</ssl_issuer_response>
    <ssl_card_number>46**********5518</ssl_card_number>
    <ssl_result>0</ssl_result>
    <ssl_txn_id>060320MB-2B27A92F-3998-47C3-9394-219272D9E93B</ssl_txn_id>
    <ssl_account_type>D</ssl_account_type>
    <ssl_approval_code>780519</ssl_approval_code>
    <ssl_amount>1.00</ssl_amount>
    <ssl_txn_time>03/06/2020 09:56:09 AM</ssl_txn_time>
    <ssl_base_amount>1.00</ssl_base_amount>
    <ssl_card_type>DEBITCARD</ssl_card_type>
    <ssl_transaction_type>VOID</ssl_transaction_type>
    <ssl_account_balance>0.00</ssl_account_balance>
    <ssl_reference_number>35769</ssl_reference_number>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_partner_app_id>VM</ssl_partner_app_id>
</txn>