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:

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

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:  cashsale
Required20alphanumeric
ssl_amountTransaction 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 decimal places.
Required11numeric
[Tip Processing]Use only on terminals that are set up with the Market Segment set to Service
ssl_tip_amountTip or Gratuity Amount
Amount to add or update to the transaction amount.
Format: Number with 2 decimals places
Optional11numeric
ssl_serverServer ID
Unique identifier of the clerk, waiter, waitress or cashier.
Optional8alphanumeric
ssl_shiftShift ID
Unique identifier of the time period, course or service type.
Optional4alphanumeric
ssl_phonePhone
Phone number on the cardholder’s / customer’s account or billing address.
Format: Accepts dashes.
Required20numeric

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 Debit Card Response Codes section for an extensive list of possible returned messages.
ssl_txn_idTransaction ID
Unique identifier of the transaction.
ssl_txn_timeProcessing 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
ssl_amountTotal 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.
ssl_base_amountBase Amount
Original transaction amount sent in the request. Returned based on the terminal setup.
ssl_tip_amountTip Amount
Added or updated tip or gratuity amount. Returned based on the terminal setup.
ssl_serverServer ID
Server identifier sent in the request. Returned based on the terminal setup.
ssl_shiftShift
Shift information sent in the request. Returned based on the terminal setup.
[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

important

  • In 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>cashsale</ssl_transaction_type>
    <ssl_amount>10.00</ssl_amount>
    <ssl_first_name>Test First</ssl_first_name>
    <ssl_last_name>Test Last</ssl_last_name>
    <ssl_avs_address>test road</ssl_avs_address>
    <ssl_address2>suite 1</ssl_address2>
    <ssl_city>TestTown</ssl_city>
    <ssl_avs_zip>12345</ssl_avs_zip>
    <ssl_state>TX</ssl_state>
    <ssl_country>USA</ssl_country>
    <ssl_email>mytest@email.com</ssl_email>
    <ssl_phone>888-777-7777</ssl_phone>
    <ssl_company>Test Inc</ssl_company>
    <ssl_salestax>2</ssl_salestax>
    <ssl_merchant_txn_id>txnid</ssl_merchant_txn_id>
</txn>

Response

<txn>
    <ssl_txn_time>04/26/2022 10:22:38 PM</ssl_txn_time>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_transaction_type>SALE</ssl_transaction_type>
    <ssl_card_short_description/>
    <ssl_result>0</ssl_result>
    <ssl_txn_id>260422ED4-677469D6-B13E-40C1-A674-2D2F26F3C62D</ssl_txn_id>
    <ssl_salestax>2.00</ssl_salestax>
    <ssl_card_type>CASH</ssl_card_type>
    <ssl_amount>10.00</ssl_amount>
    <ssl_partner_app_id>01</ssl_partner_app_id>
</txn>