Return - ccreturn

This section describes the message parameters for Credit Card Return transaction processing, which you can submit using the Hosted Payments, Checkout.js, and XML API integration methods. Refer to the Integration Methods section for more information.

The ccreturn transaction issues a partial or full refund to a cardholder’s credit card using the Transaction ID of the original Sale or Force. This will guarantee that the same credit card used previously for the purchase is the one being refunded.

Enhanced credits for an amount higher than the original Sale or Force transaction amount are not allowed. Converge tracks partial refunds against the balance of the original transaction. If a partial refund would result in total refunds exceeding the value of the original transactions, Converge will return an error.

note

Converge will continue to allow merchants to refund credit card transactions using full card number or track data per current functionality using cccredit. We strongly advise however, to use the enhanced credits in order to minimize risks associated with refund abuse.

In this section:

Request

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.
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:ccreturn
Required20alphanumeric
ssl_txn_idTransaction ID
Unique identifier of the approved Sale (ccsale) or Force (ccforce) transaction to be refunded.
Required46alphanumeric
ssl_amountTransaction Amount
For a partial refund, the amount must be less than the original purchase amount.
For a full refund, this parameter must be null.
Format: Number with 2 decimals places
Conditional11numeric

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 Payment 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_approval_codeTransaction Approval Code
Unique code returned by the credit card processor that indicates the approval status of the transaction.
ssl_amountTotal Refund Amount
ssl_card_numberMasked Card Number
Converge only returns the first 2 or last 4 digits of the regular PAN, or the last 4 digits of the actual card number if it is an association token (example, ApplePay).
ssl_emailEmail Address
The cardholder’s or customer’s email address. Returned based on merchant setup.
[Address Verification Service]Returned only if AVS parameters are sent in the original Sale or Force transaction.
ssl_avs_responseAddress Verification Response Code
Refer to the AVS Response Codes section for a complete list of AVS response codes.
[Card Verification]Returned only if CVV / CVC / CID parameters are sent in the original Sale or Force transaction.
ssl_cvv2_responseCard Verification Response Code
Refer to the CVV2/CVC2 Response Codes section for a complete list of CVV/CVC2 response codes.
[Invoice Number]Returned only if Invoice Number parameters are sent in the request.
ssl_invoice_numberInvoice Number
The invoice number or ticket number sent in the original request.
[Dynamic Currency Conversion]Returned only if the terminal is set up with the Dynamic Currency credit card payment option.
Refer to the Dynamic Currency Conversion (DCC) section for more information on retrieving the following DCC transaction parameters.
ssl_conversion_rateConversion Rate
Exchange rate applied to the conversion of ssl_amount
ssl_cardholder_amountCardholder Amount
Total amount in the cardholder’s billing currency.
[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.

Example

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 for FULL return

xmldata=
<txn>
    <ssl_merchant_id>XXXXXX</ssl_merchant_id>
    <ssl_user_id>XXXXXX</ssl_user_id>
    <ssl_pin>XXXXXX</ssl_pin>
    <ssl_transaction_type>ccreturn</ssl_transaction_type>
    <ssl_txn_id>081021ED4-378FBF98-2F26-4FE4-9FF8-0E9B23F8FB51</ssl_txn_id>
</txn>

Response for FULL return

<?xml version="1.0" encoding="UTF-8"?>
<txn>
    <ssl_issuer_response>00</ssl_issuer_response>
    <ssl_last_name>Test Last</ssl_last_name>
    <ssl_company></ssl_company>
    <ssl_phone></ssl_phone>
    <ssl_card_number>41**********9990</ssl_card_number>
    <ssl_departure_date></ssl_departure_date>
    <ssl_result>0</ssl_result>
    <ssl_txn_id>121021ED3-C0474A03-854E-4E88-8D14-5927AD2B6357</ssl_txn_id>
    <ssl_avs_response> </ssl_avs_response>
    <ssl_approval_code>401054</ssl_approval_code>
    <ssl_email></ssl_email>
    <ssl_amount>0.25</ssl_amount>
    <ssl_avs_zip>12345</ssl_avs_zip>
    <ssl_txn_time>10/12/2021 01:42:31 PM</ssl_txn_time>
    <ssl_description></ssl_description>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_completion_date></ssl_completion_date>
    <ssl_address2></ssl_address2>
    <ssl_card_short_description>VISA</ssl_card_short_description>
    <ssl_customer_code></ssl_customer_code>
    <ssl_country></ssl_country>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_transaction_type>RETURN</ssl_transaction_type>
    <ssl_salestax></ssl_salestax>
    <ssl_avs_address>test road</ssl_avs_address>
    <ssl_account_balance>0.00</ssl_account_balance>
    <ssl_state></ssl_state>
    <ssl_city></ssl_city>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_first_name>Test First</ssl_first_name>
    <ssl_invoice_number></ssl_invoice_number>
    <ssl_cvv2_response></ssl_cvv2_response>
</txn>

Request for partial return (include the amount to return)

xmldata=
<txn>
    <ssl_merchant_id>XXXXXX</ssl_merchant_id>
    <ssl_user_id>XXXXXX</ssl_user_id>
    <ssl_pin>XXXXXX</ssl_pin>
    <ssl_transaction_type>ccreturn</ssl_transaction_type>
    <ssl_amount>0.10</ssl_amount>
    <ssl_txn_id>270921AD3-47900876-4BF8-4624-B775-9B992498C7C9</ssl_txn_id>
</txn>

Response for partial return (include the amount to return)

<?xml version="1.0" encoding="UTF-8"?>
<txn>
    <ssl_issuer_response>00</ssl_issuer_response>
    <ssl_last_name>Test Last</ssl_last_name>
    <ssl_company></ssl_company>
    <ssl_phone></ssl_phone>
    <ssl_card_number>41**********9990</ssl_card_number>
    <ssl_merchant_txn_id>ku340xcomqgfXMLDEMO</ssl_merchant_txn_id>
    <ssl_result>0</ssl_result>
    <ssl_txn_id>121021ED4-221E63DC-F5E7-4E04-AA95-B28B9E344B3E</ssl_txn_id>
    <ssl_avs_response> </ssl_avs_response>
    <ssl_approval_code>401527</ssl_approval_code>
    <ssl_email></ssl_email>
    <ssl_amount>0.10</ssl_amount>
    <ssl_avs_zip>12345</ssl_avs_zip>
    <ssl_txn_time>10/12/2021 01:44:40 PM</ssl_txn_time>
    <ssl_description></ssl_description>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_completion_date></ssl_completion_date>
    <ssl_address2></ssl_address2>
    <ssl_card_short_description>VISA</ssl_card_short_description>
    <ssl_customer_code></ssl_customer_code>
    <ssl_country></ssl_country>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_transaction_type>RETURN</ssl_transaction_type>
    <ssl_salestax></ssl_salestax>
    <ssl_avs_address>test road</ssl_avs_address>
    <ssl_account_balance>0.00</ssl_account_balance>
    <ssl_state></ssl_state>
    <ssl_city></ssl_city>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_first_name>Test First</ssl_first_name>
    <ssl_invoice_number></ssl_invoice_number>
    <ssl_cvv2_response></ssl_cvv2_response>
</txn>