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

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 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:ccupdatetoken
Required20alphanumeric
ssl_first_nameFirst Name
First name on the cardholder’s / customer’s account or billing address.
Required20alphanumeric
ssl_last_nameLast Name
Last name on the cardholder’s / customer’s account or billing address.
Required30alphanumeric
[Card Data]
ssl_tokenCredit 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.
Required20alphanumeric
ssl_card_numberCard Number
Card Number as it appears on the credit card.
Important: Submitting the card number generates a new token.
Optional18numeric
ssl_exp_dateCard’s Expiry Date
Date when the card becomes invalid.
Format: MMYY
Optional4numeric
ssl_exclude_account_updateExclude Account Update
A request with this field set to Y will not pass a token to the account updater.
Optional1Boolean
[Account Data]
ssl_companyCompany Name
Company name on the cardholder’s / customer’s account or billing address.
Optional50alphanumeric
ssl_customer_idCustomer ID
Merchant-defined unique customer identifier.
Optional--
ssl_avs_addressAddress Line 1
The house number and street name on the cardholder’s / customer’s account or billing address.
Optional30alphanumeric
ssl_address2Address Line 2
Apartment or condominium unit number and floor number on the cardholder’s or customer’s account or billing address.
Optional30alphanumeric
ssl_avs_zipPostal or ZIP Code
Postal or ZIP code on the cardholder’s or customer’s account or billing address.
Optional9alphanumeric
ssl_cityCity
City name on the cardholder’s / customer’s account or billing address.
Optional30alphanumeric
ssl_stateState Code
State or province code on the cardholder’s / customer’s account or billing address.
Optional2alphanumeric
ssl_countryCountry ISO Code
Country ISO code on the cardholder’s / customer’s account or billing address.
Optional3alphanumeric
ssl_emailEmail Address
The cardholder’s or customer’s email address.
Optional100alphanumeric
ssl_phonePhone
Phone number on the cardholder’s / customer’s account or billing address.
Format: Must not include spaces or dashes.
Optional10numeric
ssl_descriptionMerchant-defined Transaction Description
Short and custom text to describe the transaction.
Optional255alphanumeric
[AVS/CVV Verification]
ssl_verifyAccount 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
Optional1alphanumeric

Response

Field nameDescription
ssl_resultToken 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_messageAccount 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_idTransaction ID
Unique identifier of the transaction.
Important: Returned only if ssl_verify = Y.
ssl_txn_timeProcessing 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_codeTransaction Approval Code
Unique code that indicates the approval status of the transaction.
Important: Returned only if ssl_verify = Y.
ssl_tokenToken
Token supplied in the update request.
ssl_token_responseToken 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_responseAddress 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_responseCard 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_numberMasked 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_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.