Credit Card Force - ccforce

important

Credit Card Force is deprecated and Elavon advises against using Credit Card Force in new integrations.

This page will be maintained for legacy integrators but we recommend using Credit Card Complete if at all possible.

This section describes the message parameters for Credit Card Force 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 ccforce transaction places a previously authorized transaction into the current Unsettled batch.

In this section:

Request


ssl_merchant_id 15 \| numeric \| required	Merchant ID Elavon-assigned Converge account ID.
ssl_user_id 15 \| alphanumeric \| required	Converge User ID The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
ssl_pin 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.
ssl_transaction_type 20 \| alphanumeric \| required	Transaction Type Value: `ccforce`
ssl_amount 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. For terminals that are set up with the Multi Currency credit payment option, make sure that the number of decimal places are correct as some currencies have 0 (like JPY) or 3 (like BHD) decimal places. Format: Number with 2 decimals places
ssl_approval_code 6 \| numeric \| required	Transaction Approval Code Unique code returned by the credit card processor that indicates the approval status of the transaction.
[Card Data]	Use the appropriate card data parameters for the transaction.
ssl_card_number 18 \| numeric \| conditional	Card Number Card Number as it appears on the credit card. Important: Required for hand-keyed transactions.
ssl_exp_date 4 \| numeric \| conditional	Card's Expiry Date Date when the card becomes invalid. Important: Required if `ssl_card_number` is not null. Do not send the expiry date when the token is stored in Card Manager. Format: MMYY
ssl_card_present 1 \| alphanumeric \| optional	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.
ssl_track_data 76 \| alphanumeric \| conditional	Raw Track I and/or II Data Track data captured from the card's magnetic stripe. The data includes beginning and ending sentinels, card's expiry date, cardholder's first name, and the cardholder's last name. Important: Required for swiped and contactless transactions.
ssl_enc_track_data 160 \| alphanumeric \| conditional	Encrypted Raw Track I and/or II Data Encrypted Track I and/or II data captured from the card's magnetic stripe when using an Ingenico encrypting device. The data includes beginning and ending sentinels, card's expiry date, cardholder's first name, and the cardholder's last name.
ssl_enc_track_data_format - \| - \| conditional	Encrypted Raw Track I and/or II Data Format Format of the track data captured from the card's magnetic stripe. Valid value: `ROAM_GENERIC_TDES_EMV` Important: Required if card is read from a ROAM device.
ssl_encrypted_track1_data 160 \| alphanumeric \| conditional	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 the cardholder's last name. Important: Required for swiped and contactless transactions.
ssl_encrypted_track2_data 160 \| alphanumeric \| conditional	Encrypted Raw Track II Data Encrypted Track II data captured from the card's magnetic stripe when using a MagTek encrypting device.
ssl_ksn 20 \| alphanumeric \| conditional	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. Important: Required if using `ssl_enc_track_data`, `ssl_encrypted_track1_data` or `ssl_encrypted_track2_data`.
ssl_vm_mobile_source - \| alphanumeric \| conditional	Mobile Source Valid values: `BBERRY` - BlackBerry Mobile Device `ADROID` - Android Mobile Device `ITUNES` - Apple Mobile Device `WIN8` - Windows WIN8-based Device `NOMOB` - Non-mobile Device Important: Required for encrypting devices.
ssl_vendor_id 8 \| alphanumeric \| conditional	Vendor ID Unique vendor identifier assigned by Elavon. Important: Required for encrypting devices.
ssl_mobile_id 50 \| alphanumeric \| conditional	Mobile ID Unique assigned mobile identification number of each mobile device in use as determined by the merchant. Important: Optional for encrypting devices.
ssl_token 20 \| alphanumeric \| conditional	Credit Card Token Encrypted card data that can replace `ssl_card_number`. Important: The token must already be stored in Card Manager. Use only if the terminal is set up with the Tokenization terminal option.
ssl_pos_mode 2 \| numeric \| optional	POS Device Data Entry Capability Indicates how the POS device captures card data. Valid values: `01` - Manual entry only `02` - Magnetic swipe-capable `03` - Proximity or contactless-capable `04` - EMV chip-capable (ICC) - Contact only with magnetic stripe `05` - EMV chip-capable (ICC) - Dual interface with magnetic stripe
ssl_entry_mode 2 \| numeric \| optional	Transaction Entry Indicator Indicates how the track data was captured. Valid values: `01` - Key entered - Card not present `02` - Key entered - Card present `03` - Swiped (default) `04` - Proximity/Contactless
[Doing Business As]	Use only on terminals that are set up with the DBA Name terminal option.
ssl_dynamic_dba 21 \| alphanumeric \| optional	Doing Business As Name Merchant-defined descriptors that replace the merchant's business name on credit card statements. Format: PrefixDescriptor Length:* Prefix = 3, 7, or 12, Asterisk = 1, Descriptor = 21 - (Prefix + Asterisk) Example: MANYMAG*BAKERS MONTHLY
[Tokenization]	Use only on terminals that are set up with the Tokenization terminal option.
ssl_get_token 1 \| alphanumeric \| optional	Generate Token Indicator Indicates whether to generate a token when submitting the card data. Valid values: `Y` - Authorize transaction and generate token `N` - Do not generate token (Default) If set to Y, the following parameters are mandatory: Hand-keyed `ssl_card_number` `ssl_exp_date` Swiped/Contactless `ssl_track_data` Encrypted Swiped/Contactless `ssl_enc_track_data` (Ingenico) `ssl_encrypted_track1_data` (MagTek) `ssl_encrypted_track2_data` (MagTek)
ssl_add_token 1 \| alphanumeric \| optional	Add to Card Manager Indicator Indicates whether to generate and store the token in Card Manager. Valid values: `Y` - Authorize transaction, generate and store token `N` - Do not store token (Default)
[Tip Processing]	Use only on terminals that are set up with the Market Segment set to Service.
ssl_tip_amount 11 \| numeric \| required	Tip or Gratuity Amount Amount to add or update to the transaction amount. Format: Number with 2 decimals places
ssl_server 8 \| alphanumeric \| optional	Server ID Unique identifier of the clerk, waiter, waitress or cashier.
ssl_shift 4 \| alphanumeric \| optional	Shift ID Unique identifier of the time period, course or service type.
[Card Verification]	Use only on terminals that are set up with the CVV2, CVC2, CID credit card payment option.
ssl_cvv2cvc2 4 \| numeric \| optional	Card Verification Value / Card Validation Code Card security code or number printed on the card and commonly used for card not present payment transactions.
ssl_cvv2cvc2_indicator 1 \| numeric \| optional	Card Verification Value / Card Validation Code Indicator Indicates the status of the card security code or number during the transaction. Valid values: `0` - Bypassed `1` - Present `2` - Illegible `9` - Not Present
[Purchasing Cards]	Use only on terminals that are set up with the Purchasing Card 2 credit card payment option.
ssl_customer_code 17 \| alphanumeric \| optional	Customer Code or Purchase Order Number Customer ID or PO number specified in the billing statement of the cardholder.
ssl_salestax 8 \| alphanumeric \| optional	Sales Tax Tax amount to add to the purchase or sales amount. For a tax exempt transaction, enter 0.00. Format: Amount with 2 decimal places.
[Invoice Number]	Use only on terminals that are set up with the Invoice Number credit card payment option.
ssl_invoice_number 25 \| alphanumeric \| optional	Invoice/Ticket Number Unique identifier of the invoice or ticket.
[Multi-Currency Conversion]	Use only on terminals that are set up with the Multi Currency credit card payment option. Refer to the Multi-Currency Conversion (MCC) section for more information on processing MCC transactions.
ssl_transaction_currency 3 \| alphanumeric \| optional	Transaction Currency The currency ISO code that the merchant applies to their goods or services. Default: USD or CAD
[Travel Data]	Use only on terminals that are set up with the Travel Data credit card payment option.
ssl_departure_Date 10 \| alphanumeric \| optional	Travel Departure Date Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking. Format: MM/DD/YYYY
ssl_completion_Date 10 \| alphanumeric \| optional	Travel Completion Date Date sent to the Merchant Airline Risk Monitoring System (MARMS) to monitor risks associated with advanced booking. Format: MM/DD/YYYY
[Optional Fields]
ssl_avs_address 30 \| alphanumeric \| optional	Address Line 1 Commonly the house number and street name on the cardholder's / customer's account or billing address. Address Verification Service (AVS) data compared with the address on the card issuer's file. Recommended for hand-keyed transactions to qualify for better interchange rates.
ssl_avs_zip 9 \| alphanumeric \| optional	Postal or ZIP Code ZIP code on the cardholder's account or billing address. Address Verification Service (AVS) data compared with the postal or ZIP code on the card issuer's file. Recommended for hand-keyed transactions to qualify for better interchange rates.
ssl_description 255 \| alphanumeric \| optional	Merchant-defined Transaction Description Short and custom text to describe the transaction.

Response


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 The amount includes the Tip amount, if submitted in the request.
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_card_short_description	Short Card Brand Name Valid values are `AMEX`, `CUP`, `DISC`, `MC`, `PP`, and `VISA`.
ssl_card_type	Payment Type Valid value: `CREDITCARD`
[Tokenization]	Returned only if Tokenization parameters are sent in the request.
ssl_token	Token Generated from the credit card number.
ssl_token_response	Token Generation Outcome A value of `SUCCESS` indicates Converge generted the token. Other values returned are `FAILURE`, `Action Not Permitted`, `Invalid Token`, `Not Permitted`, and `Acct Verification Failed`.
ssl_add_token_response	Add to Card Manager Outcome Valid values are `Card Added`, `Card Updated`, `Not Permitted`, and `FAILURE - First Name - is requried`.
[Tip Processing]	Returned only if Tip parameters are sent in the request.
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.
[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.
[Multi-Currency Conversion]	Returned only if MCC parameters are sent in the request.
ssl_transaction_currency	Transaction Currency
[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_txn_currency_code	Transaction Currency Code The cardholder's billing currency code.
ssl_markup	Markup The markup applied to the Reference Exchange Rate when calculating the `ssl_conversion_rate` value to use for converting the merchant's Pricing Currency to `ssl_txn_currency_code`.
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 currency. Returned only if Tip Processing parameters are sent in the request.
ssl_cardholder_tip_amount	Tip Amount Tip amount in the cardholder currency. Returned only if Tip Processing parameters are sent in the request.
[Partial Approval]	Returned only if Partial Approval parameters are sent in the request. If the customer indicates that they do not wish to continue with the additional tender type, the point of sale application must send a reversal to cancel this payment and reestablish the balance back to the card. A reversal can be achieved by sending a `ccdelete` in terminal-based terminals or `ccvoid` in host-based terminals.
ssl_requested_amount	Requested Amount Original requested amount on partial approvals.
ssl_balance_due	Remaining Balance The difference between the requested amount and the authorized amount, which the merchant will collect from the customer.
ssl_account_balance	Account Balance Available balance on the card, which is 0.00 for a partially authorized transaction.
[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.