Get Card Account Updater Summary

This API endpoint retrieves the summary of the card account updater for a specific merchant or list of merchants within a specific date range. By default, it will return the card account updater for all merchants

Get Card Account Updater Report

GET https://<Platform-host>/api/cards/card-updater

Query parameters

Name	Type	Description
card_updater_updated_at[from]	string	Specifies the start date for retrieving cards that were automatically enrolled by the card updater service. This does not include manual card updates or changes made by via update token API.
card_updater_updated_at[to]	string	Specifies the end date for retrieving cards that were automatically enrolled by the card updater service. This does not include manual card updates or changes made by via update token API.
merchant_ids	string	A list of merchant IDs for which the card account updater summary should be retrieved

Response

200 List of Card Account Updater Summary

Name	Type	Description	Required?
data.cards_enrolled	integer	Count of cards that are enrolled for the Card Account Updater	Required
data.card_updater_report	object	Card Updater summary details	Required
data.card_updater_report.updated	integer	Count of cards that are updated	Required
data.card_updater_report.closed	integer	Count of cards that are closed i.e. the corresponding cardholder's account is closed	Required
data.card_updater_report.unknown	integer	Count of cards that are marked as unknown by the card account updater since no account was found from the participating BIN	Required
data.card_updater_report.opt_out	integer	Count of cards that are opt-out of the card account updater. The cardholder can place an opt-out note on their card	Required
data.card_updater_report.non_participating	integer	Count of cards that are not participating in the card account updater	Required
data.card_updater_report.contact_cardholder_advice	integer	Count of cards that are flagged by the issuer since something has changed and these cards cannot be updated automatically	Required

Sample Request and Response

Sample Request

curl --location --request GET '<API_HOST>/api/cards/card-updater' \

--header 'Authorization: Basic <API_KEY>'

Sample Response

{
    "data": {
        "cards_enrolled": 200,
        "card_updater_report": {
            "updated": 2,
            "closed": 2,
            "unknown": 0,
            "opt_out": 0,
            "non_participating": 0,
            "contact_cardholder_advice": 0
        }
    }
}