Verification - ccverify

This section describes the message parameters for Credit Card Account Verification 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 ccverify transaction verifies the credit card account for AVS and CVV data. AVS and CVV codes are returned to indicate if the AVS and CVV data passed originally were correct and matched the cardholder statement billing address and the CVV value located on the card.

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: `ccverify`	Required	20	alphanumeric
[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 for hand-keyed transactions.	Conditional	18	numeric
`ssl_exp_date`	Card’s Expiry Date Date when the card becomes invalid. Format: MMYY Important: Required if `ssl_card_number` is not null. Do not send the expiry date when the token is stored in Card Manager.	Conditional	4	numeric
`ssl_card_present`	Card Present Indicator Indicates whether the card is physically present during the transaction. Recommended for hand-keyed transactions. Valid values: `Y` - Card present `N` - Card not present	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 and last name. Required for swiped 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 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	NA	NA
`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. important 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	NA	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_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) 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`	Optional	1	alphanumeric
`ssl_add_token`	Add to Card Manager Indicator Indicates whether to add token and cardholder details to Card Manager. Valid values: `Y` - Add or update the generated token and the cardholder details if the transaction is approved `N` - Do not add the token or cardholder details (Default)	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
[Address Verification Service]
`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.	Required	30	alphanumeric
`ssl_avs_zip`	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.	Required	9	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.	Required	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	Required	1	numeric

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_issuer_response`	Original Issuer Response The issuer response returned during the authorization attempt. An `ssl_issuer_response` = 00 indicates success. An `ssl_issuer_response` not equal to 00 indicates a decline or failure.
`ssl_txn_id`	Transaction ID Unique identifier of the transaction.
`ssl_transaction_type`	Transaction Type Indicates the type of 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_account_balance`	Account Balance Available balance on the credit card.
`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`	Card Type Payment method used for the transaction. Valid Values: `CREDITCARD`
`ssl_par_value`	Payment Account Reference (PAR) from original auth
`ssl_association_token_data`	Association token indidcator Used to identify if the data in the account data field contains an association defined token replacement value instead of the original account data. Valid values: `0` - No association token used `1` - The data in the account data field is an association defined token value
`ssl_brand_token_eligibility_indicator`	Identifies if the transactions is eligible for the brand tokenization services Valid values: `1` for Token Program `Space` for Not Applicable
[Address Verification Service]
`ssl_avs_response`	Address Verification Response Code Refer to the AVS Response Codes section for a complete list of AVS response codes.
[Card On File]
`ssl_oar_data`	Original Authorization Response Data (OAR) This data will be as received during the original authorization processing. This is a retain and return value for terminal-based settlement messages. You may store this field with the payment details from the transaction to make future Card On File transactions.
`ssl_ps2000_data`	PS2000 This data will be as received during the original authorization processing. This is a retain and return value for terminal-based settlement messages. You must store this field with the payment details from the transaction to make future Card On File transactions.
[Card Verification]
`ssl_cvv2_response`	Card Verification Response Code Refer to the CVV2/CVC2 Response Codes section for a complete list of CVV/CVC2 response codes.
[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_transaction_type>ccverify</ssl_transaction_type>
    <ssl_card_number>5413330002001049</ssl_card_number>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_first_name>John</ssl_first_name>
    <ssl_last_name>Doe</ssl_last_name>
    <ssl_cvv2cvc2>1234</ssl_cvv2cvc2>
    <ssl_avs_address>2 Concourse Parkway</ssl_avs_address>
    <ssl_city>Atlanta</ssl_city>
    <ssl_state>GA</ssl_state>
    <ssl_avs_zip>12345</ssl_avs_zip>
    <ssl_country>USA</ssl_country>
</txn>

Response

<txn>
    <ssl_issuer_response>85</ssl_issuer_response>
    <ssl_transaction_type>CARDVERIFICATION</ssl_transaction_type>
    <ssl_card_number>54**********1049</ssl_card_number>
    <ssl_oar_data>010001417004271858400427027344400000000000669325MCC244536</ssl_oar_data>
    <ssl_result>0</ssl_result>
    <ssl_txn_id>270422A41-376C2756-F972-49EB-8BDD-A78F4C301F73</ssl_txn_id>
    <ssl_brand_token_eligibility_indicator>1</ssl_brand_token_eligibility_indicator>
    <ssl_avs_response>A</ssl_avs_response>
    <ssl_approval_code>669325</ssl_approval_code>
    <ssl_txn_time>04/27/2022 02:58:40 PM</ssl_txn_time>
    <ssl_account_balance>0.00</ssl_account_balance>
    <ssl_ps2000_data>MMCC244536      0427</ssl_ps2000_data>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_card_short_description>MC</ssl_card_short_description>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_cvv2_response>M</ssl_cvv2_response>
    <ssl_partner_app_id>01</ssl_partner_app_id>
</txn>

Cash Advance

Apple Pay

Magento Guide

Verification - ccverify

Request

Response

Example

Request

Response