Token Query - ccquerytoken

This section describes the message parameters for Card Manager Token Query transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.

The ccquerytoken transaction retrieves information associated with a token.

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: ccquerytoken
ssl_exclude_account_update
1 | Boolean | optional
Exclude Account Update

A request with this field set to Y will not pass a token to the account updater.

[Card Data]
 
ssl_token
20 | alphanumeric | required
Credit Card Token
The Token ID to query.
Important:
  • The token must already be stored in Card Manager.
  • Use only if the terminal is set up with the Tokenization   terminal option.

Response

ssl_card_type
 
Payment Type
Valid value: CREDITCARD
ssl_token
 
Token
Token supplied in the query request.
ssl_account_number
 
Masked Account Number
Converge only returns the first and last 4 digits of the actual account number.
ssl_exp_date
 
Card's Expiry Date
Returned based on merchant setup.
ssl_company
 
Company Name
Company name on the cardholder's / customer's account or billing address.
Returned based on merchant setup.
ssl_customer_id
 
Customer ID
Merchant-defined unique customer identifier.
Returned based on merchant setup.
ssl_first_name
 
First Name
First name on the cardholder's / customer's account or billing address.
Returned based on merchant setup.
ssl_last_name
 
Last Name
Last name on the cardholder's / customer's account or billing address.
Returned based on merchant setup.
ssl_avs_address
 
Address Line 1
Commonly the house number and street name on the cardholder's / customer's account or billing address.
Returned based on merchant setup.
ssl_address2
 
Address Line 2
Apartment or condominium unit number and floor number on the cardholder's or customer's account or billing address.
Returned based on merchant setup.
ssl_avs_zip
 
Postal or ZIP Code
Postal or ZIP code on the cardholder's or customer's account or billing address.
Returned based on merchant setup.
ssl_city
 
City
City name on the cardholder's / customer's account or billing address.
Returned based on merchant setup.
ssl_state
 
State Code
State or province code on the cardholder's / customer's account or billing address.
Returned based on merchant setup.
ssl_country
 
Country ISO Code
Country ISO code on the cardholder's / customer's account or billing address.
Returned based on merchant setup.
ssl_phone
 
Phone
Phone number on the cardholder's / customer's account or billing address.
Returned based on merchant setup.
ssl_email
 
Email Address
The cardholder's or customer's email address.
Returned based on merchant setup.
ssl_description
 
Merchant-defined Transaction Description
Short and custom text to describe the transaction.
Returned based on merchant setup.
[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.