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

Field nameDescriptionRequiredLengthData type
ssl_merchant_idMerchant ID
Elavon-assigned Converge account ID.
Required15numeric
ssl_user_idConverge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
Required15alphanumeric
ssl_pinTerminal 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.
Required64alphanumeric
ssl_transaction_typeTransaction Type
Value:ccquerytoken
Required20alphanumeric
[Card Data]
ssl_tokenCredit 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.
Required20alphanumeric

Response

Field nameDescription
ssl_card_typePayment Type
Valid value:CREDITCARD
ssl_tokenToken
Token supplied in the query request.
ssl_account_numberMasked Account Number
Converge only returns the first and last 4 digits of the actual account number.
ssl_exp_dateCard’s Expiry Date
Returned based on merchant setup.
ssl_companyCompany Name
Company name on the cardholder’s / customer’s account or billing address.
Returned based on merchant setup.
ssl_customer_idCustomer ID
Merchant-defined unique customer identifier.
Returned based on merchant setup.
ssl_first_nameFirst Name
First name on the cardholder’s / customer’s account or billing address.
Returned based on merchant setup.
ssl_last_nameLast Name
Last name on the cardholder’s / customer’s account or billing address.
Returned based on merchant setup.
ssl_avs_addressAddress 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_address2Address 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_zipPostal or ZIP Code
Postal or ZIP code on the cardholder’s or customer’s account or billing address.
Returned based on merchant setup.
ssl_cityCity
City name on the cardholder’s / customer’s account or billing address.
Returned based on merchant setup.
ssl_stateState Code
State or province code on the cardholder’s / customer’s account or billing address.
Returned based on merchant setup.
ssl_countryCountry ISO Code
Country ISO code on the cardholder’s / customer’s account or billing address.
Returned based on merchant setup.
ssl_phonePhone
Phone number on the cardholder’s / customer’s account or billing address.
Returned based on merchant setup.
ssl_emailEmail Address
The cardholder’s or customer’s email address.
Returned based on merchant setup.
ssl_descriptionMerchant-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.
errorCodeError 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.
errorMessageError Message
Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
errorNameError Name
Error name or reason for the error.