Token Update - ccupdatetoken
This section describes the message parameters for Card Manager Token Update transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.
The ccupdatetoken transaction updates the information associated with a token.
In this section:
For the entire list of API endpoints, refer to API Endpoints.
Request
error_outline
note
- You can verify the account before the update. If the card is declined, the token will not update.
- Only include the parameters you want to update.
- You can set some parameters to null by sending empty values.
| 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: ccupdatetoken | Required | 20 | alphanumeric |
ssl_first_name | First Name First name on the cardholder’s / customer’s account or billing address. | Required | 50 | alphanumeric |
ssl_last_name | Last Name Last name on the cardholder’s / customer’s account or billing address. | Required | 50 | alphanumeric |
| [Card Data] | ||||
ssl_token | Credit Card Token The Token ID to update. Important:
| Required | 20 | alphanumeric |
ssl_card_number | Card Number Card Number as it appears on the credit card. Important: Submitting the card number generates a new token. | Optional | 18 | numeric |
ssl_exp_date | Card’s Expiry Date Date when the card becomes invalid. Format: MMYY | Optional | 4 | numeric |
ssl_exclude_account_update | Exclude Account Update A request with this field set to Y will not pass a token to the account updater. | Optional | 1 | Boolean |
| [Account Data] | ||||
ssl_company | Company Name Company name on the cardholder’s / customer’s account or billing address. | Optional | 50 | alphanumeric |
ssl_customer_id | Customer ID Merchant-defined unique customer identifier. | Optional | - | - |
ssl_avs_address | Address Line 1 The house number and street name on the cardholder’s / customer’s account or billing address. | Optional | 30 | alphanumeric |
ssl_address2 | Address Line 2 Apartment or condominium unit number and floor number on the cardholder’s or customer’s account or billing address. | Optional | 30 | alphanumeric |
ssl_avs_zip | Postal or ZIP Code Postal or ZIP code on the cardholder’s or customer’s account or billing address. | Optional | 9 | alphanumeric |
ssl_city | City City name on the cardholder’s / customer’s account or billing address. | Optional | 30 | alphanumeric |
ssl_state | State Code State or province code on the cardholder’s / customer’s account or billing address. | Optional | 2 | alphanumeric |
ssl_country | Country ISO Code Country ISO code on the cardholder’s / customer’s account or billing address. | Optional | 3 | alphanumeric |
ssl_email | Email Address The cardholder’s or customer’s email address. | Optional | 100 | alphanumeric |
ssl_phone | Phone Phone number on the cardholder’s / customer’s account or billing address. Format: Accepts dashes. | Optional | 20 | numeric |
ssl_description | Merchant-defined Transaction Description Short and custom text to describe the transaction. | Optional | 255 | alphanumeric |
| [AVS/CVV Verification] | ||||
ssl_verify | Account Verification Indicator Indicates whether Converge needs to verify the account before generating a token. Valid values:
| Optional | 1 | alphanumeric |
Response
| Field name | Description |
|---|---|
ssl_result | Token Update Result Code An ssl_result = 0 indicates a generated token.An ssl_result = 1 indicates that a token is not generated.Important: Returned only if ssl_verify = Y. |
ssl_result_message | Account Verification Result Message Refer to the Account Verification Response Message section for an extensive list of possible returned messages. Important: Returned only if ssl_verify = Y. |
ssl_txn_id | Transaction ID Unique identifier of the transaction. Important: Returned only if ssl_verify = Y. |
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/2010 10:34:10 AM Important: Returned only if ssl_verify = Y. |
ssl_approval_code | Transaction Approval Code Unique code that indicates the approval status of the transaction. Important: Returned only if ssl_verify = Y. |
ssl_token | Token Token supplied in the update request. |
ssl_token_response | Token Update 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_avs_response | Address Verification Response Code Refer to the AVS Response Codes section for a complete list of AVS response codes. Important: Returned only if ssl_verify = Y. |
ssl_cvv2_response | Card Verification Response Code Refer to the CVV2/CVC2 Response Codes section for a complete list of CVV/CVC2 response codes. Important: Returned only if ssl_verify = Y. |
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_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. |