Credit Card Credit - cccredit

error_outline

important

Elavon advises against using Credit Card Credit to issue refunds.

Refunds issued with cccredit can exceed the amount of the original transaction and bears an increased risk for fraud and chargebacks.

If possible, we recommend using Credit Card Return to handle your refunds. ccreturn caps the total possible refunds on each transaction at the original amount and prevents even refunds from exceeding that amount.

The cccredit transaction is used to issue a return (refund) to a cardholder’s credit card using full card number.

In this section:

Request

Field name Description Required Length Data type
ssl_transaction_type Transaction Type
Valid value: cccredit
Required 20 alphanumeric
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_encrypted_track1_data Encrypted Raw Track I Data
Encrypted Track I data captured from the card's magnetic stripe when using a MagTek encrypting device. The data includes beginning and ending sentinels, card's expiry date, cardholder's first name and last name.
error_outline

important

Required for swiped and contactless transactions.

Conditional 160 alphanumeric
ssl_encrypted_track2_data Encrypted Raw Track II Data
Encrypted Track II data captured from the card's magnetic stripe when using a MagTek encrypting device.
Conditional 160 alphanumeric
ssl_enc_track_data Encrypted Raw Track I and/or II Data
Encrypted Track I and/or II data captured from the card's magnetic stripe or an Ingenico encrypting device. The data includes beginning and ending sentinels, card's expiry date, cardholder's first and last name.
Conditional 160 alphanumeric
ssl_ksn Key Serial Number
Unique identifier generated from the swiped payment card and returned by the encrypting device. The KSN encrypts the PAN data through the DUKPT method.
Required if submitting ssl_enc_track_data, ssl_enc_track1_data or ssl_enc_track2_data in the transaction request.
Conditional 20 alphanumeric
ssl_card_number Card Number
Unique card identification number.
Card length:
18 - Gift Card
19 - Credit Card
Conditional 18 or 19 numeric
ssl_exp_date Card's Expiry Date
Date when the card becomes invalid.
Format: MMYY
error_outline

important

  • Required if ssl_card_number is not null.
Conditional 4 numeric
ssl_card_present Card Present Indicator
Indicates whether the card is physically present during the transaction.
Valid values:
Y - Card present
N - Card not present
Recommended for hand-keyed transactions.
Optional 1 alphanumeric
ssl_amount Transaction Amount to be refunded. For those terminals processing Multi-Currency, be sure to submit the correct number of decimal places for the transaction as some currencies have no exponents and some can have three.
Format: Number with 2 decimals places
Required 11 numeric
ssl_departure_Date Travel Departure Date
Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking.
Format: MM/DD/YYYY
error_outline

important

Only applicable to terminals that are set up with the Travel Data credit payment option.

Optional 10 alphanumeric
ssl_completion_Date Travel Completion Date
Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking.
Format: MM/DD/YYYY
error_outline

important

Only applicable to terminals that are set up with the Travel Data credit payment option.

Optional 10 alphanumeric
ssl_transaction_currency Transaction Currency
The currency ISO code that the merchant applies to their goods or services.
Default: USD or CAD
error_outline

important

Only applicable to terminals that are set up with the Multi Currency credit payment option.

Optional 3 alphanumeric
ssl_get_token Generate Token Indicator
Indicates whether to generate a token when submitting the card data.
Valid values:
Y - Generate token
N - Do not generate token (Default)
Only applicable to terminals that are set up with the Tokenization terminal option.
Optional 1 alphanumeric
ssl_add_token Add to Card Manager Indicator
Indicates whether to generate and store the token in Card Manager.
Valid values:
Y - Generate and store token
N - Do not store token (Default)
error_outline

important

Only applicable to terminals that are set up with the Tokenization terminal option.

Optional 1 alphanumeric
[Dynamic DBA]
ssl_dynamic_dba Dynamic DBA
The dynamic doing business as name for this transaction.
Allows a merchant specify, on a per-transaction basis, wording that may be more recognizable or more service-specific to the customer than their usual business name.
This can prevent chargebacks by preventing users from seeing transactions attached to unrelated names on their payment card statements.
Optional 21 alphanumeric
ssl_dynamic_dba_address Dynamic DBA Address
The dynamic doing business as street address for this transaction.
This value allows a merchant use an alternate address for this transaction.
30 alphanumeric
ssl_dynamic_dba_auth_type Merchant ID
The dynamic doing business as authorization type.
Valid values:
F - Final
P - Pre-authorize
1 alphanumeric
ssl_dynamic_dba_city Dynamic City Name
This value allows a merchant use an alternate city as part of the address for this transaction
13 alphanumeric
ssl_dynamic_dba_country Dynamic Country ISO Code
This value allows a merchant specify an alternate country as part of the address for this transaction.
3 alphanumeric
ssl_dynamic_dba_email Dynamic Email Address
This value allows a merchant specify an alternate email address for this transaction.
70 alphanumeric
ssl_dynamic_dba_mcc Dynamic Merchant Category Code
This value allows a merchant specify an alternate merchant category for this transaction.
22 numeric
ssl_dynamic_dba_phone Dynamic Phone Number
This value allows a merchant specify an alternate phone number for this transaction.
20 alphanumeric
ssl_dynamic_dba_postal Dynamic Postal or ZIP Code
This value allows a merchant set an alternate postal code for a transaction.
9 alphanumeric
ssl_dynamic_dba_state Dynamic State Code
This value allows a merchant set an alternate state code for a transaction.
2 alphanumeric
ssl_dynamic_dba_submid Dynamic Sub-merchant ID
This value allows a merchant set an alternate sub-merchant ID for a transaction.
22 numeric
ssl_dynamic_dba_taxid Dynamic Merchant Tax ID
This value allows a merchant set an alternate Tax ID for this transaction.
14 alphanumeric

Response

Field name Description
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 Payment Card Response Codes section for an extensive list of possible returned messages.
ssl_txn_id Transaction ID
Unique identifier of the transaction.
ssl_txn_time 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
ssl_approval_code Transaction Approval Code
Unique code returned by the credit card processor that indicates the approval status of the transaction.
ssl_amount Total Authorized/Approved Transaction Amount
Returned based on merchant setup.
ssl_card_number Masked 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_email Email 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 request.
ssl_avs_response Address 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 request.
ssl_cvv2_response Card 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_number Invoice 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_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.
[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: XML API Request/Response

The following example demonstrates the xml code for a credit card return transaction for $10.00 where the merchant collects all the data from the consumer:

<txn>
    <ssl_merchant_ID>my_vid_id</ssl_merchant_ID>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>cccredit</ssl_transaction_type>
    <ssl_card_number>0000000000000000</ssl_card_number>
    <ssl_exp_date>1220</ssl_exp_date>
    <ssl_amount>10.00</ssl_amount>
    <ssl_first_name>John</ssl_first_name>
    <ssl_last_name>Doe</ssl_last_name>
    <ssl_avs_address>123 Main</ssl_avs_address>
    <ssl_city>Atlanta</ssl_city>
    <ssl_state>GA</ssl_state>
    <ssl_avs_zip>99999</ssl_avs_zip>
    <ssl_country>USA</ssl_country>
</txn>

This is the response for a credit card return approved transaction for $10.00:

<txn>
    <ssl_card_short_description>mc</ssl_card_short_description>
    <ssl_first_name>John</ssl_first_name>
    <ssl_last_name>Doe</ssl_last_name>
    <ssl_account_balance>0.00</ssl_account_balance>
    <ssl_txn_id>111016A15-F5043074-6620-4A4C-B4FA-E12FD6EC64A0</ssl_txn_id>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_result>0</ssl_result>
    <ssl_approval_code></ssl_approval_code>
    <ssl_card_type>creditcard</ssl_card_type>
    <ssl_card_number>0000000000000000</ssl_card_number>
    <ssl_exp_date>1220</ssl_exp_date>
    <ssl_amount>10.00</ssl_amount>
    <ssl_avs_address>123 Main</ssl_avs_address>
    <ssl_city>Atlanta</ssl_city>
    <ssl_state>GA</ssl_state>
    <ssl_avs_zip>99999</ssl_avs_zip>
    <ssl_country>USA</ssl_country>
    <ssl_txn_time>10/11/2016 04:46:33 PM</ssl_txn_time>
</txn>