Sale - cashsale

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

The cashsale transaction enters a purchase by cash.

In this section:


15 | numeric | required
Merchant ID
Elavon-assigned Converge account ID.
15 | alphanumeric | required
Converge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
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.
20 | alphanumeric | required
Transaction Type
Value: cashsale
11 | numeric | required
Transaction Amount
The Sale amount that includes the Net and Sales Tax amounts.
For Tip Processing,  the Sale amount must not include the Tip amount.
Format: Number with 2 decimals places
[Tip Processing]
Use only on terminals that are set up with the Market Segment set to Service.
11 | numeric | optional
Tip or Gratuity Amount
Amount to add or update to the transaction amount.
Format: Number with 2 decimals places
8 | alphanumeric | optional
Server ID
Unique identifier of the clerk, waiter, waitress or cashier.
4 | alphanumeric | optional
Shift ID
Unique identifier of the time period, course or service type.


Transaction Outcome
An ssl_result = 0 indicates an approved transaction.
An ssl_result not equal to 0 indicates a declined and unauthorized transaction.
Transaction Result Message
Refer to the Cash Response Codes section for an extensive list of possible returned messages.
Transaction ID
Unique identifier of the transaction.
Processing Date and Time
Indicates when Converge processed the transaction.
Format: MM/DD/YYYY hh:mm:ss AM/PM
Example: 03/18/2010 10:34:10 AM
Total Authorized/Approved Transaction Amount
The amount includes the Tip amount, if submitted in the request.
[Tip Processing]
Returned only if Tip  parameters are sent in the request.
Base Amount
Original transaction amount sent in the request. Returned based on the terminal setup.
Tip Amount
Added or updated tip or gratuity amount. Returned based on the terminal setup.
Server ID
Server identifier sent in the request. Returned based on the terminal setup.
Shift information sent in the request. Returned based on the terminal setup.
Returned only if an error occurs. Refer to the Error Codes section for more information.
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.
Error Message
Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
Error Name
Error name or reason for the error.