Total/Summary - total

This section describes the message parameters for End of Day Transactions Summary processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.

The total transaction obtains a summary of all transactions waiting to be settled. This transaction allows the merchant to review the batch prior to settlement.

In this section:

Request

note

  • Users must have the Batches-View Transactions user right in order to request a summary.
  • This transaction will not return pended, set to review, or Auth Only transactions.
Field nameDescriptionRequiredLengthData type
ssl_merchant_idMerchant ID
Elavon-assigned Converge account ID.
Required15numeric
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.
Important: The ssl_user_id sending the transaction request must be associated with the terminal that will process the request.
Required64alphanumeric
ssl_transaction_typeTransaction Type
Value:total
Required20alphanumeric

Response

Field nameDescription
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_result_messageTransaction Result Message
Refer to the Transaction Summary Response Codes section for an extensive list of possible returned messages.
Important: An Empty batch response indicates that there are no transactions in the current batches waiting to be settled.
ssl_txn_main_countTotal Transaction Count in Main Batch
ssl_txn_main_amountTotal Transaction Amount in Main Batch
ssl_txn_cash_countTotal Cash Count in Cash Batch
ssl_txn_cash_amountTotal Cash Amount in Cash Batch
ssl_txn_loyalty_countTotal Loyalty Card Count in Loyalty Batch
ssl_txn_loyalty_amountTotal Loyalty Card Amount in Loyalty Batch
ssl_txn_ecg_countTotal Gift Card Count in Gift Batch
ssl_txn_ecg_amountTotal Gift Card Amount in Gift Batch
[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.