Aggregate Credit Card Account

Overview

The Aggregate Credit Card Account insight is a refresh-triggered insight that recommends aggregating a credit card account. The insight is generated only if the system identifies a card payment in any of the user's aggregated bank accounts.

Following are the additional details for the insight:

Insight Name AGGREGATE_CREDIT_CARD_ACCOUNT
Applicable Entity ACCOUNT
Insight Type AGGREGATE
Trigger Type REFRESH
Supported Container BANK

Use Cases

  • Customer:
    • More User Data - Build a better financial picture of the user.
  • User:
    • A holistic view of all users's accounts in a single place.
    • More in-depth and meaningful insights with the user's full financial data in place.

Suggested Action

Provide the user an option to aggregate accounts using FastLink. For more information, see FastLink 4.0.

Duplicate Insight Checks

To prevent the same insight from generating repeatedly, the insight is generated once in 31 days (including the date of insight evaluation) for a user.

Insight Dynamic Trigger (On-Demand Evaluation)

The insight cannot be triggered on-demand using any of the on-demand trigger mechanisms currently available.

Peer Benchmarking Data

This insight does not provide peer benchmarking data.

Thresholds

Threshold does not apply to this insight.

GET Customer Subscription

The GET customer subscription API provides all the information about the defaults set for the insights that are subscribed by the customer.

Method and URL:

GET   /insights/configs/customerSubscriptions

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}
Content-Type application/json
Api-Version 2
Cobrand-Name {Name of the Customer}

Sample Request:

/insights/configs/customerSubscriptions

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

{
   "customerSubscription":[
    {
            "insightName": "AGGREGATE_CREDIT_CARD_ACCOUNT",
            "insightTitle": "Aggregate Credit Card Account",
            "insightType": "AGGREGATE",
            "triggerType": "REFRESH",
            "container": [
                "BANK"
            ],
            "description": "Generates an insight to alert user to aggregate his credit card account if a credit card payment is found for the user in any of his bank accounts.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true
                }
            ]
        }
   ]
}

PATCH Customer Subscription

Using the PATCH API for customer subscription, customers can change the defaults for each insight. Alternatively, customers can use the insights configuration tool to achieve the same result.

Warning!: Changing any defaults can potentially impact all users who have subscribed to this insight. If the user has overridden the customer threshold, then the user preference will be applied. For all other users, the new defaults will apply.

Method and URL:

PATCH   /insights/configs/customerSubscriptions

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}
Content-Type application/json
Api-Version 2
Cobrand-Name {Name of the Customer}

Editable Parameters:

Editable Attributes Impact Allowed Values
isSubscribed Subscribes or unsubscribes all the users from the Aggregate Credit Card Account insight. true, false
insightTitle The title returned by the GET feed API as well as the insights config tool can be changed. Alphanumeric characters up to 100 characters (including spaces)

Sample Request:

{
    "customerSubscription": [
        {
            "insightName": "AGGREGATE_CREDIT_CARD_ACCOUNT",
            "insightTitle": "Aggregate Credit Card Account",
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true
                }
            ]
        }
    ]
}

Response Messages:

HTTP Status Code Reason
400 Y806: Invalid Input
400 Y800: Invalid value for insightName
400 Y800: Invalid value for insightTitle; special characters ></\"'%{}|^~[] are not supported
400 Y801: Invalid length for insightTitle; min 3 and max 100 characters including spaces are allowed.
400 Y802: For insight AGGREGATE_CREDIT_CARD_ACCOUNT, modifying applicableEntity is not allowed
400 Y802: For insight AGGREGATE_CREDIT_CARD_ACCOUNT, modifying triggerType is not allowed
400 Y802: For insight AGGREGATE_CREDIT_CARD_ACCOUNT, modifying container is not allowed
400 Y802: For insight AGGREGATE_CREDIT_CARD_ACCOUNT, modifying description is not allowed
400 Y800: Invalid value for isSubscribed; Supported values are true, false
400 Y825: Update not allowed without a valid request body
400 Y803: Invalid request; Either a valid insightTitle or customerConfiguration is required.
400 Y802: Specifying frequency attribute for AGGREGATE_CREDIT_CARD_ACCOUNT insight is not allowed
400 Y802: Specifying duration attribute for AGGREGATE_CREDIT_CARD_ACCOUNT insight is not allowed
400 Y802: For AGGREGATE_CREDIT_CARD_ACCOUNT insight passing threshold is not allowed
400 Y812: Required field/value - insightName missing in the request
400 Y802: Modifying InsightType attribute is not allowed
400 Y813 :entityType should be provided
400 Y803 :At least one additional attribute is required in addition to entityType.
400 Y800: Invalid value for customerConfiguration; customerConfiguration is either missing, duplicated, or has insufficient/ incorrect attributes.
400 Y800: Invalid value for entityType. Supported entityType for AGGREGATE_CREDIT_CARD_ACCOUNT insight are - [ACCOUNT]
400 Y800 : Invalid value for input json
401 Y020: Invalid token in authorization header
401 Y020: Token has expired

GET User Subscription

The GET user subscription API provides all the information about the user defaults set for the insight.

The entityId filter does not apply to this insight.

Method and URL:

GET   /insights/configs/userSubscriptions

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service}
Content-Type application/json
Api-Version 2
Cobrand-Name {Name of the Customer}

Sample Request:

/insights/configs/userSubscriptions?insightName=AGGREGATE_CREDIT_CARD_ACCOUNT

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

{
   "userSubscription":[
    {
            "insightName": "AGGREGATE_CREDIT_CARD_ACCOUNT",
            "insightTitle": "Aggregate Credit Card Account",
            "insightType": "AGGREGATE",
            "triggerType": "REFRESH",
            "container": [
                "BANK"
            ],
            "description": "Generates an insight to alert user to aggregate his credit card account if a credit card payment is found for the user in any of his bank accounts.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true
                }
            ]
        }
   ]
}

PATCH User Subscription

Using the PATCH user subscription API for user subscription, users can change the defaults for each insight. If the user wants the insight to be evaluated for a new account, then add that account using the PATCH user subscription API. The customer default threshold values will apply if the user has not set any values.

Method and URL:

PATCH   /insights/configs/userSubscriptions

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service}
Content-Type application/json
Api-Version 2
Cobrand-Name {Name of the Customer}

Editable Parameters:

Editable Attributes Impact Allowed Values
isSubscribed Subscribes or unsubscribes to the Aggregate Credit Card Account insight. true, false

Sample Request:

{
   "userSubscription":[
      {
         "insightName": "AGGREGATE_CREDIT_CARD_ACCOUNT",
         "userConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true
            }
         ]
      }
   ]
}

Error Messages:

HTTP Status Code Reason
400 Y806: Invalid input
400 Y800: Invalid value for insightName
400 Y800: Invalid value for input param in AGGREGATE_CREDIT_CARD_ACCOUNT insight
400 Y802: Modifying insightTitle using this API is not allowed
400 Y802: For insight AGGREGATE_CREDIT_CARD_ACCOUNT, modifying applicableEntity is not allowed
400 Y802: For insight AGGREGATE_CREDIT_CARD_ACCOUNT, modifying triggerType is not allowed
400 Y802: For insight AGGREGATE_CREDIT_CARD_ACCOUNT, modifying container is not allowed
400 Y802: For insight AGGREGATE_CREDIT_CARD_ACCOUNT, modifying description is not allowed
400 Y802: Specifying frequency attribute for AGGREGATE_CREDIT_CARD_ACCOUNT insight is not allowed
400 Y800: Invalid value for isSubscribed; Supported values are true, false
400 Y802: Specifying duration attribute for AGGREGATE_CREDIT_CARD_ACCOUNT insight is not allowed
400 Y825: Update not allowed without a valid request body
400 Y802: For AGGREGATE_CREDIT_CARD_ACCOUNT insight passing threshold is not allowed
400 Y812: Required field/value - insightName missing in the request
400 Y802: Modifying InsightType attribute is not allowed
400 Y813: entityType should be provided
400 Y803: At least one additional attribute is required in addition to entityType.
400 Y800: Invalid value for userConfiguration; userConfiguration is either missing, duplicated, or has insufficient/ incorrect attributes
400 Y802: For insight AGGREGATE_CREDIT_CARD_ACCOUNT, configurations at an entityId level are not allowed
400 Y800: Invalid value for entityType. Supported entityType for AGGREGATE_CREDIT_CARD_ACCOUNT insight are - [ACCOUNT]
400 Y800 : Invalid value for input json
401 Y020: Invalid token in authorization header
401 Y020: Token has expired

GET Insight Feeds

The GET insights feed API retrieves all or a subset of the valid insight notifications generated for a particular user. However, using the insightName filter, you can specifically request for the Aggregate Credit Card Account insight only.

The entityId filter does not apply to this insight.

Method and URL:

GET   /insights/feed

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service}
Content-Type application/json
Api-Version 2
Cobrand-Name {Name of the Customer}

Sample Request:

/insights/feed?insightName=AGGREGATE_CREDIT_CARD_ACCOUNT

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

{
   "feed":[
      {
         "id":"60d43d99d59fdb46b0c910d3",
         "insightName":"AGGREGATE_CREDIT_CARD_ACCOUNT",
         "insightTitle":"Aggregate Credit Card Account",
         "insightType":"AGGREGATE",
         "triggerType":"REFRESH",
         "createdDate":"2021-06-24T08:08:49Z",
         "subscription":[
            {
               "entityType":"ACCOUNT"
            }
         ],
         "basicAccount":[
            {
               "id":13709572,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data- All Category",
               "accountType":"OTHER",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=13709572"
               },
               "basicTransaction":[
                  {
                     "id":47307044,
                     "amount":{
                        "amount":1308.75,
                        "currency":"USD"
                     },
                     "date":"2021-06-21",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=47307044"
                     },
                     "categoryId":26,
                     "category":"Credit Card Payments",
                     "categoryType":"TRANSFER",
                     "baseType":"DEBIT",
                     "description":{
                        "original":"GEM VISA GEM Visa",
                        "simple":"GEM VISA GEM Visa"
                     },
                     "sourceType":"AGGREGATED",
                     "merchantType":"BILLERS"
                  },
                  {
                     "id":47307043,
                     "amount":{
                        "amount":1344.75,
                        "currency":"USD"
                     },
                     "date":"2021-06-21",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=47307043"
                     },
                     "categoryId":26,
                     "category":"Credit Card Payments",
                     "categoryType":"TRANSFER",
                     "baseType":"DEBIT",
                     "description":{
                        "original":"GEM VISA    X00000X010X3 0X2002XX35X3",
                        "simple":"GEM VISA xX0000X010X3 0x2002XX35X3"
                     },
                     "sourceType":"AGGREGATED",
                     "merchantType":"OTHERS"
                  },
                  {
                     "id":47307000,
                     "amount":{
                        "amount":1308.75,
                        "currency":"USD"
                     },
                     "date":"2021-06-21",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=47307000"
                     },
                     "categoryId":26,
                     "category":"Credit Card Payments",
                     "categoryType":"TRANSFER",
                     "baseType":"DEBIT",
                     "description":{
                        "original":"INTERNET BPAY GO MASTERCARD 521XXXXXXXXX4220  TRANSFER DEBIT",
                        "simple":"Payment to MasterCard via Mastercard"
                     },
                     "sourceType":"AGGREGATED",
                     "merchantType":"BILLERS",
                     "basicMerchant":{
                        "name":"MasterCard"
                     }
                  }
               ],
               "message":{
                  "messageText":"You have credit card payments but you haven't aggregated any credit card account. Aggregate to let us help track your spending accurately"
               }
            }
         ]
      }
   ]
}