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:
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 Value: ccquerytoken | Required | 20 | alphanumeric |
| [Card Data] | ||||
ssl_token | Credit Card Token The Token ID to query. Important:
| Required | 20 | alphanumeric |
Response
| Field name | Description |
|---|---|
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. |