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:

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.

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: ccupdatetoken
ssl_first_name
20 | alphanumeric | required
First Name
First name on the cardholder's / customer's account or billing address.
ssl_last_name
30 | alphanumeric | required
Last Name
Last name on the cardholder's / customer's account or billing address.
[Card Data]
 
ssl_token
20 | alphanumeric | required
Credit Card Token
The Token ID to update.
Important:
  • The token must already be stored in Card Manager.
  • Use only if the terminal is set up with the Tokenization   terminal option.
ssl_card_number
18 | numeric | optional
Card Number
Card Number as it appears on the credit card.
Important: Submitting the card number generates a new token.
ssl_exp_date
4 | numeric | optional
Card's Expiry Date
Date when the card becomes invalid.
Format: MMYY
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.

[Account Data]
 
ssl_company
50 | alphanumeric | optional
Company Name
Company name on the cardholder's / customer's account or billing address.
ssl_customer_id
- | - | optional
Customer ID
Merchant-defined unique customer identifier.
ssl_avs_address
30 | alphanumeric | optional
Address Line 1
Commonly the house number and street name on the cardholder's / customer's account or billing address.
ssl_address2
30 | alphanumeric | optional
Address Line 2
Apartment or condominium unit number and floor number on the cardholder's or customer's account or billing address.
ssl_avs_zip
9 | alphanumeric | optional
Postal or ZIP Code
Postal or ZIP code on the cardholder's or customer's account or billing address.
ssl_city
30 | alphanumeric | optional
City
City name on the cardholder's / customer's account or billing address.
ssl_state
2 | alphanumeric | optional
State Code
State or province code on the cardholder's / customer's account or billing address.
ssl_country
3 | alphanumeric | optional
Country ISO Code
Country ISO code on the cardholder's / customer's account or billing address.
ssl_email
100 | alphanumeric | optional
Email Address
The cardholder's or customer's email address.
ssl_phone
10 | numeric | optional
Phone
Phone number on the cardholder's / customer's account or billing address.
Important: Must not include spaces or dashes.
ssl_description
255 | alphanumeric | optional
Merchant-defined Transaction Description
Short and custom text to describe the transaction.
[AVS/CVV Verification]
 
ssl_verify
1 | alphanumeric | optional
Account Verification Indicator
Indicates whether Converge needs to verify the account before generating a token.
Valid values:
  • Y - Verify account prior to token generation
  • N - Generate token without account verification

Response

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.