Update Tip - ccupdatetip

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

The ccupdatetip transaction adds, modifies or resets a tip (gratuity) amount on an open approved Credit Card Sale or Force transaction.

error_outline

note

  • This transaction is supported in the Service market segment.
  • Tips are updated or added after the transaction has been processed, typically at the end of the day prior to Settlement.
  • Tip amount can be sent in the cardholder amount.
  • The transaction may be sent several times prior to settlement if needed.

In this section:

Request

Field name Description Required Length Data type
ssl_merchant_id Merchant ID
Elavon-assigned Converge account ID.
Required 15 numeric
ssl_user_id Converge user ID
The user ID with Hosted Payment API user status that can send transaction requests through the terminal.
Required 15 alphanumeric
ssl_pin Terminal ID
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
error_outline

important

The ssl_user_id sending the transaction request must be associated with the terminal that will process the request.

Required 64 alphanumeric
ssl_transaction_type Transaction Type
Valid value: ccupdatetip
Required 20 alphanumeric
ssl_txn_id Transaction ID
Unique identifier of the open approved Sale (ccsale) or Force (ccforce) transaction.
Required 46 alphanumeric
ssl_tip_amount Tip or Gratuity Amount
Tip amount to add, update or reset.
Set to 0.00 to reset or remove the original tip amount.
The last and most current tip sent will be processed as the tip amount.
Format: Number with 2 decimals places
Required 11 numeric
ssl_server Server ID
Unique identifier of the clerk, waiter, waitress or cashier.
Send if updating the server ID of the existing transaction.
Optional 8 alphanumeric
ssl_shift Shift ID
Unique identifier of the time period, course or service type.
Send if updating the server ID of the existing transaction.
Optional 4 alphanumeric
[Dynamic Currency Conversion]
ssl_cardholder_tip_amount Tip or Gratuity Amount
Amount to add or update when Converge processes the original transaction as a Dynamic Currency Conversion (DCC) transaction and that the authorized amount is in the cardholder's currency.
To reset or remove the original tip amount from a DCC transaction, set the value to 0.00.
Format: Number with 2 decimal places
error_outline

important

Only applicable to terminals set up for the Service market segment and with the Dynamic Currency credit payment option.

Conditional 11 numeric

Response

Field name Description
ssl_result_message Transaction Result Message
A result of SUCCESS indicates that the tip was updated or added.
A result of ERROR indicates that the tip was not added or updated.
ssl_txn_id Transaction ID
Unique identifier of the transaction.
ssl_amount Total Transaction Amount
The amount includes the Tip amount. The most current tip amount sent will reflect in the total transaction amount.
ssl_base_amount Base Amount
Original transaction amount sent in the request. Returned based on the terminal setup.
ssl_tip_amount Tip Amount
Added or updated tip or gratuity amount. Returned based on the terminal setup.
ssl_server Server ID
Server identifier sent in the request. Returned based on the terminal setup.
ssl_shift Shift
Shift information sent in the request. Returned based on the terminal setup.
[Dynamic Currency Conversion] Returned only if the terminal is set up with the Dynamic Currency credit card payment option and DCC parameters are sent in the request.
ssl_conversion_rate Conversion Rate
Exchange rate applied to the conversion of ssl_amount.
ssl_cardholder_amount Cardholder Amount
Total amount in the cardholder's billing currency.
ssl_cardholder_currency Cardholder Currency
ssl_cardholder_base_amount Base Amount
Base amount in the cardholder's currency.
ssl_cardholder_tip_amount Tip Amount
Tip amount in the cardholder's currency.
[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.

Example

error_outline

important

  • In this example, 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>ccupdatetip</ssl_transaction_type>
    <ssl_txn_id>TEST43B-D0638677-26EB-40F5-B2F9-3AF2545DE144</ssl_txn_id>
    <ssl_tip_amount>5.00</ssl_tip_amount>
    <ssl_shift>Lunch</ssl_shift>
    <ssl_server>Jane</ssl_server>
</txn>

Response

xmldata=<txn>
    <ssl_result_message>SUCCESS</ssl_result_message>
    <ssl_txn_id>101641221593ACBA6-BAFD-76B7-4948-B3DE68CFD0CC</ssl_txn_id>
    <ssl_amount>15.00</ssl_amount>
    <ssl_base_amount>10.00</ssl_base_amount>
    <ssl_tip_amount>5.00</ssl_tip_amount>
    <ssl_shift>Lunch</ssl_shift>
    <ssl_server>Jane</ssl_server>
</txn>