Account Update Query

Account Manager is an Elavon subscription Service that automatically updates the card status for Visa and MasterCard records on file. Merchants subscribing to this service who need to update a large number of stored card profiles can use AccountUpdateQuery.

AccountUpdateQuery returns the accounts sorted in descending order of date updated and can return up to 100 accounts in a single request. If a request returns would return more than 100 accounts, Converge will 'page' the data. The response of a query with more than 100 results will automatically return ssl_date_updated. Pass this value as the ssl_search_start_date of another request to view the next 100 (or fewer) accounts. For more information, see the sample flow for multi-page responses.

error_outline
note

Whenever AccountUpdateQuery yields a status code result, Converge will send a summary report email to the merchant. This email will contain the old and new token values.

In this section:

Request

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: AccountUpdateQuery
ssl_page_number
NA | int | optional
Page Number

The page number for queries that yield more than 1000 results.

Default Value: 1

ssl_search_start_date
10 | alphanumeric | conditional
Search Filter - Start Date
Start date for the transaction date range. If you submit a start date without an end date, Converge sets the value of ssl_search_end_date to ssl_search_start_date plus 31 days.
Default: End date - 31 days
Format: MM/DD/YYYY
ssl_search_end_date
10 | alphanumeric | optional
Search Filter - End Date
End date for the transaction date range. If you submit an end date without a start date, Converge sets the value of ssl_search_start_date to ssl_search_end_date minus 31 days.
Default: Start date + 31 days
Format: MM/DD/YYYY
ssl_status_code
1 | alphanumeric | optional
Account Status
Valid values:
  • A - Account Information Updated
  • B - Expiry Date Updated
  • C - Account Closed
  • D - Contact Customer
  • G - Non-participating BIN

Response

ssl_token_group_id
 
Token Group ID
The unique identifier of the token group to which the search result belongs.
ssl_old_token
 
Previous Token ID
The previous token ID of the account.
ssl_new_token
 
New Token ID
The new token ID of the account.
ssl_card_type
 
Payment Type
Valid values: LOYALTY, CASHBENEFIT, CASH, DEBITCARD, FOODSTAMP, CREDITCARD, GIFTCARD, ELECTRONICCHECK,
ssl_date_updated
 
Update Date
The date when the account was updated.
ssl_new_account_closed
 
Closed Account Indicator
Indicates that the account is closed.
ssl_new_account_prefix
 
New Account Prefix
The new prefix for the account.
ssl_new_account_suffix
 
New Account Suffix
The new suffix for the account.
ssl_new_exp_date
 
New Expiry Date
The updated expiry date for the account.
ssl_old_account_closed
 
Closed Date
Close date for account prior to update.
ssl_old_account_prefix
 
Old Account Prefix
The prefix of the account prior to the update.
ssl_old_account_suffix
 
Old Account Suffix
The suffix of the account prior to the update.
ssl_old_exp_date
 
Old Expiry Date
The expiry date of the account prior to the update.
ssl_page_number
 
Page Number

The page number for a query.

Each page of query results can contain a maximum of 1000 items. If a query's results would return more than 1000 items, you will need to send a second request with a new page number to view those items

ssl_next_page
 
Next Page

If this field is returned, there is another page of results in the query.

You can use the integer returned by this field as the ssl_page_number value in a subsequent request.

ssl_status_code
 
Account Status
Valid values:
  • A - Account Information Updated
  • B - Expiry Date Updated
  • C - Account Closed
  • D - Contact Customer
  • G - Non-participating BIN

Examples

error_outline
important
  • In all of these examples, you will have to change the data values, such as my_merchant_id, my_user_id, my_pin, and transaction data to match your Converge account and meet the needs of your website.
  • Code samples provided are for demonstration only and should not be used for live transactions. All sensitive merchant data, including transaction amounts and your Converge credentials, should be placed in server side code.

Request

Basic Account Update Query Request

<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>AccountUpdateQuery</ssl_transaction_type>
</txn>

Account Update Query Request with Additional Search Criteria

<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>AccountUpdateQuery</ssl_transaction_type>
    <ssl_search_start_date>05/10/2017 08:30:00 AM</ssl_search_start_date>
    <ssl_search_end_date>08/13/2017</ssl_search_end_date>
    <ssl_status_code>C</ssl_status_code>
</txn>

Response

Basic Response

<account_update_list>
    <token_list>
        <list_count>66</list_count>
        <token>
            <ssl_token_group_id>135</ssl_token_group_id>
            <ssl_old_token>389778751688883</ssl_old_token>
            <ssl_new_token>289778751688882</ssl_new_token>
            <ssl_card_type>CREDITCARD</ssl_card_type>
            <ssl_date_updated>07/12/2017 04:15:16 AM</ssl_date_updated>
            <ssl_new_account_closed></ssl_new_account_closed>
            <ssl_new_account_prefix></ssl_new_account_prefix>
            <ssl_new_account_suffix>8882</ssl_new_account_suffix>
            <ssl_new_exp_date>1219</ssl_new_exp_date>
            <ssl_old_account_closed></ssl_old_account_closed>
            <ssl_old_account_prefix></ssl_old_account_prefix>
            <ssl_old_account_suffix>8883</ssl_old_account_suffix>
            <ssl_old_exp_date>1218</ssl_old_exp_date>
            <ssl_status_code>A</ssl_status_code>
        </token>
    </token_list>
</account_update_list>

Multi-Page Response

You will have to handle queries with search parameters yielding more than 1000 valid responses using multiple requests.

  1. After sending an accountupdatequery with more than 1000 results in the list, the response will contain a ssl_next_page value. Take note of this value.

    <account_update_list>
        </token_list>
        <recurring_list>
        <list_count>1000</list_count>
        <ssl_next_page>2</ssl_next_page>
  2. Create a new AccountUpdateQuery request with the same parameters as the previous one apart from ssl_page_number

    <txn>
        <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
        <ssl_user_id>my_user_id</ssl_user_id>
        <ssl_pin>my_pin</ssl_pin>
        <ssl_transaction_type>AccountUpdateQuery</ssl_transaction_type>
        <ssl_page_number>2<ssl_page_number>
    </txn>
  3. Set the value of ssl_page_number to the value of ssl_next_page and then send the request.

  4. Converge will return another response containing up to 1000 more accounts.

For queries that yield more than 2000 responses, you will need to repeat the above process multiple times to navigate the entire multi-page response.