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:

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

Request

Field name	Description	Required	Length	Data type
`ssl_merchant_id`	Merchant ID Elavon-assigned Converge Account ID (AID).	Required	6 or 7	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. 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: `ccforce`	Required	20	alphanumeric
`ssl_amount`	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	Required	11	numeric
`ssl_approval_code`	Transaction Approval Code Unique code returned by the credit card processor that indicates the approval status of the transaction.	Required	6	numeric
[Card data]	Use the appropriate card data parameters for the transaction.
`ssl_card_number`	Card number Card number as it appears on the credit card. Required when adding an installment record using a card number.	Conditional	18	numeric
`ssl_exp_date`	Card’s Expiry Date Date when the card becomes invalid. Format: MMYY 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_track_data`	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 last name. Required for swiped and contactless transactions.	Conditional	76	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 when using an Ingenico encrypting device. The data includes beginning and ending sentinels, card’s expiry date, cardholder’s first name and last name.	Conditional	160	alphanumeric
`ssl_enc_track_data_format`	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` Required if card is read from a ROAM device.	Conditional	-	-
`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 using `ssl_enc_track_data`.	Conditional	20	alphanumeric
`ssl_vm_mobile_source`	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 Required for encrypting devices.	Conditional	-	alphanumeric
`ssl_vendor_id`	Vendor ID Unique vendor identifier assigned by Elavon. Required for encrypting devices and certification.	Conditional	8	alphanumeric
`ssl_mobile_id`	Mobile ID Unique assigned mobile identification number of each mobile device in use as determined by the merchant. Optional for encrypting devices.	Conditional	50	alphanumeric
`ssl_token`	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.	Conditional	20	alphanumeric
`ssl_token_provider`	Credit Card Token Provider This code indicates the provider for the token. This value is also visible in the Converge UI. Valid values: P for legacy tokens. V for Voltage tokens	Optional	1	alphanumeric
`ssl_pos_mode`	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	Optional	2	numeric
`ssl_entry_mode`	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)	Optional	2	numeric
[Doing Business As]	Use only on terminals that are set up with the DBA Name terminal option.
`ssl_dynamic_dba`	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) Important: DBA Prefix must be set using DBA Payment Fields Settings UI if ssl_dynamic_dba is used. Example: MANYMAG*BAKERS MONTHLY	Conditional	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.	Optional	30	alphanumeric
`ssl_dynamic_dba_auth_type`	Merchant ID The dynamic doing business as authorization type. Valid values: `F` - Final `P` - Pre-authorize	Optional	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	Optional	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.	Optional	3	alphanumeric
`ssl_dynamic_dba_email`	Dynamic Email Address This value allows a merchant specify an alternate email address for this transaction.	Optional	70	alphanumeric
`ssl_dynamic_dba_mcc`	Dynamic Merchant Category Code This value allows a merchant specify an alternate merchant category for this transaction.	Optional	22	numeric
`ssl_dynamic_dba_phone`	Dynamic Phone Number This value allows a merchant specify an alternate phone number for this transaction.	Optional	20	alphanumeric
`ssl_dynamic_dba_postal`	Dynamic Postal or ZIP Code This value allows a merchant set an alternate postal code for a transaction.	Optional	9	alphanumeric
`ssl_dynamic_dba_state`	Dynamic State Code This value allows a merchant set an alternate state code for a transaction.	Optional	2	alphanumeric
`ssl_dynamic_dba_submid`	Dynamic Sub-merchant ID This value allows a merchant set an alternate sub-merchant ID for a transaction.	Optional	22	numeric
`ssl_dynamic_dba_taxid`	Dynamic Merchant Tax ID This value allows a merchant set an alternate Tax ID for this transaction.	Optional	14	alphanumeric
[Tokenization]	Use only on terminals that are set up with the Tokenization terminal option.
`ssl_get_token`	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: `ssl_track_data` Encrypted Swiped/Contactless `ssl_enc_track_data`	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` - Authorize transaction, generate and store token `N` - Do not store token (Default)	Optional	1	alphanumeric
[Tip Processing]	Use only on terminals that are set up with the Market Segment set to Service
`ssl_tip_amount`	Tip or Gratuity Amount Amount to add or update to the transaction amount. Format: Number with 2 decimal places.	Required	11	numeric
`ssl_server`	Server ID Unique identifier of the clerk, waiter, waitress or cashier.	Optional	8	alphanumeric
`ssl_shift`	Shift ID Unique identifier of the time period, course or service type.	Optional	4	alphanumeric
[Card Verification]	Use only on terminals that are set up with the CVV2, CVC2, CID credit card payment option.
`ssl_cvv2cvc2`	Card Verification Value / Card Validation Code Card security code or number printed on the card and commonly used for card not present payment transactions.	Optional	4	numeric
`ssl_cvv2cvc2_indicator`	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	Optional	1	numeric
[Purchasing Cards]	Use only on terminals that are set up with the Purchasing Card 2 credit card payment option.
`ssl_customer_code`	Customer Code or Purchase Order Number Customer ID or PO number specified in the billing statement of the cardholder.	Optional	17	alphanumeric
`ssl_salestax`	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.	Optional	8	alphanumeric
[Invoice Number]	Use only on terminals that are set up with the Invoice Number credit card payment option.
`ssl_invoice_number`	Invoice/Ticket Number Unique identifier of the invoice or ticket.	Optional	25	alphanumeric
[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`	Transaction Currency The currency ISO code that the merchant applies to their goods or services. Default: USD or CAD	Optional	3	alphanumeric
[Travel Data]	Use only on terminals that are set up with the Travel Data credit card payment option.
`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	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	Optional	10	alphanumeric
[Optional Fields]
`ssl_avs_address`	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.	Optional	30	alphanumeric
`ssl_avs_zip`	Postal or ZIP Code ZIP code on the cardholder’s account or billing address. (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.	Optional	9	alphanumeric
`ssl_description`	Merchant-defined Transaction Description Short and custom text to describe the transaction.	Optional	255	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/2022 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_card_short_description`	Short Card Brand Name Valid values: `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_provider`	Credit Card Token Provider This code indicates the provider for the token. This value is also visible in the Converge UI. Valid values: P for legacy tokens. V for Voltage tokens
`ssl_token_response`	Token Generation Outcome A value of `SUCCESS` indicates Converge generated 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: `Card Added`, `Card Updated`, `Not Permitted`, `FAILURE - First Name - is required`
[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.

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

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>ccforce</ssl_transaction_type>
    <ssl_card_number>4111111111111111</ssl_card_number>
    <ssl_exp_date>12/22</ssl_exp_date>
    <ssl_amount>25.00</ssl_amount>
    <ssl_approval_code>426578</ssl_approval_code>
    <ssl_avs_address>first street</ssl_avs_address>
    <ssl_avs_zip>95391</ssl_avs_zip>
</txn>

Response

<txn>
    <ssl_card_number>41**********1111</ssl_card_number>
    <ssl_departure_date></ssl_departure_date>
    <ssl_result>0</ssl_result>
    <ssl_txn_id>250422E3A-0BB07D7E-93FD-4E9F-AD17-BE1883BD57A3</ssl_txn_id>
    <ssl_avs_response></ssl_avs_response>
    <ssl_approval_code>426578</ssl_approval_code>
    <ssl_amount>25.00</ssl_amount>
    <ssl_transaction_currency>CAD</ssl_transaction_currency>
    <ssl_txn_time>04/25/2022 02:05:00 PM</ssl_txn_time>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_card_short_description>VISA</ssl_card_short_description>
    <ssl_completion_date></ssl_completion_date>
    <ssl_customer_code></ssl_customer_code>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_transaction_type>FORCE</ssl_transaction_type>
    <ssl_salestax>0.00</ssl_salestax>
    <ssl_account_balance>0.00</ssl_account_balance>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_invoice_number></ssl_invoice_number>
    <ssl_cvv2_response></ssl_cvv2_response>
    <ssl_partner_app_id>01</ssl_partner_app_id>
</txn>

Cash Advance

Apple Pay

Magento Guide

Credit Card Force - ccforce

Request

Response

Example

Request

Response