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

error_outline

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.
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: total

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 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_count
 
Total Transaction Count in Main Batch
 
ssl_txn_main_amount
 
Total Transaction Amount in Main Batch
 
ssl_txn_cash_count
 
Total Cash Count in Cash Batch
 
ssl_txn_cash_amount
 
Total Cash Amount in Cash Batch
 
ssl_txn_loyalty_count
 
Total Loyalty Card Count in Loyalty Batch
 
ssl_txn_loyalty_amount
 
Total Loyalty Card Amount in Loyalty Batch
 
ssl_txn_ecg_count
 
Total Gift Card Count in Gift Batch
 
ssl_txn_ecg_amount
 
Total Gift Card Amount in Gift Batch
 
[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.