Credit Utilization Warning - All Cards

Overview

The Credit Utilization Warning (all cards) insight is a refresh-triggered insight that alerts the user when the credit card utilization percentage across all their credit cards exceeds the user-defined threshold. The utilization percentage is the ratio of total running balance across all the cards to total credit limit across all the cards.

Note: Cards that have a credit limit are only considered for this insight.

Following are the additional details for the insight:

Insight Name	CREDIT_UTILIZATION_ALL_CARDS
Applicable Entity	ACCOUNT
Insight Type	AGGREGATE
Trigger Type	REFRESH
Supported Container	CARD

Use Cases

Customer:
- User engagement
- Offer debt consolidation loans if relevant.
User:
- Financial awareness - Keep track of spending.
- Improve credit score

Suggested Action

Recommend the user to keep the utilization under a certain % to improve credit scores.

Duplicate Insight Checks

To prevent the same insight from generating repeatedly, the insight is generated once every 16 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 lets the customer and the user decide when the insight has to be generated to inform the user about an utilization warning. If the total utilization percentage exceeds the configured percent LIMIT, then the insight will be generated.

Threshold Name: UPPER_LIMIT
Data Type: PERCENT
Range Allowed: 1.00 <= CHANGE <= 100.00
Default: 30

Note: Depending on the customer segment and account, the threshold might need to be different for different users. If the default value is insufficient, the users can set a threshold they are comfortable tracking.

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`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /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.

Api-Version 3.0 and 2.1 Response

{
  "customerSubscription": [
   {
            "insightName": "CREDIT_UTILIZATION_ALL_CARDS",
            "insightTitle": "Credit Utilization Warning (all cards)",
            "insightType": "AGGREGATE",
            "triggerType": "REFRESH",
            "containers": [
                "CARD"
            ],
            "description": "Generates an insight when the balance on all credit cards is more than a configured threshold.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "threshold": [
                        {
                            "name": "UPPER_LIMIT",
                            "value": "30",
                            "type": "PERCENT"
                        }
                    ]
                }
            ]
        }
  ]
}

Api-Version 2 Response

{
  "customerSubscription": [
   {
            "insightName": "CREDIT_UTILIZATION_ALL_CARDS",
            "insightTitle": "Credit Utilization Warning (all cards)",
            "insightType": "AGGREGATE",
            "triggerType": "REFRESH",
            "container": [
                "CARD"
            ],
            "description": "Generates an insight when the balance on all credit cards is more than a configured threshold.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "threshold": [
                        {
                            "name": "UPPER_LIMIT",
                            "value": "30",
                            "type": "PERCENT"
                        }
                    ]
                }
            ]
        }
  ]
}

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`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Editable Parameters:

Editable Attributes	Impact	Allowed Values
isSubscribed	Subscribes or unsubscribes all the users from the Credit Utilization Warning(all cards) insight.	true, false
insightTitle	The title returned in the GET feed API as well as the insights config tool can be changed.	Alphanumeric characters up to 100 characters (including spaces)
threshold	The threshold (UPPER_LIMIT) can be modified to adjust the credit utilization percentage.	Any number between 1.00 and 100.00

Sample Request:

{
   "customerSubscription":[
      {
         "insightName":"CREDIT_UTILIZATION_ALL_CARDS",
         "insightTitle":"New Title",
          "customerConfiguration": [
                 {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "threshold": [
                        {
                            "name": "UPPER_LIMIT",
                            "value": "30",
                            "type": "PERCENT"
                        }
                    ]
                }
            ]
      }
   ]
}

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	Y800: Invalid value for UPPER_LIMIT in CREDIT_UTILIZATION_ALL_CARDS insight Min = 1.00 and Max = 100.00
400	Y813: Invalid request. The entire object within threshold should be provided
400	Y802: For insight CREDIT_UTILIZATION_ALL_CARDS, modifying applicableEntity is not allowed
400	Y802: For insight CREDIT_UTILIZATION_ALL_CARDS, modifying triggerType is not allowed
400	Y802: For insight CREDIT_UTILIZATION_ALL_CARDS, modifying container is not allowed
400	Y802: For insight CREDIT_UTILIZATION_ALL_CARDS, 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 CREDIT_UTILIZATION_ALL_CARDS insight is not allowed
400	Y802: Specifying duration attribute for CREDIT_UTILIZATION_ALL_CARDS insight 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 CREDIT_UTILIZATION_ALL_CARDS insight are - [ACCOUNT]
400	Y802: For CREDIT_UTILIZATION_ALL_CARDS insight, {Invalid String} inside the threshold is either repeated or not allowed
400	Y802: For CREDIT_UTILIZATION_ALL_CARDS insight, {Invalid String} inside the threshold is not allowed
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`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /insights/configs/userSubscriptions?insightName=CREDIT_UTILIZATION_ALL_CARDS

Sample Response:

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

Api-Version 3.0 and 2.1 Response

{
   "userSubscription":[
      {
         "insightName":"CREDIT_UTILIZATION_ALL_CARDS",
         "insightTitle":"Credit Utilization Warning (all cards)",
         "insightType":"AGGREGATE",
         "triggerType":"REFRESH",
         "containers":[
            "CARD"
         ],
         "description":"Generates an insight when the balance on all credit cards is more than a configured threshold.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "userConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "threshold":[
                  {
                     "name":"UPPER_LIMIT",
                     "value":"30",
                     "type":"PERCENT"
                  }
               ]
            }
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "threshold":[
                  {
                     "name":"UPPER_LIMIT",
                     "value":"30",
                     "type":"PERCENT"
                  }
               ]
            }
         ]
      }
   ]
}

Api-Version 2 Response

{
   "userSubscription":[
      {
         "insightName":"CREDIT_UTILIZATION_ALL_CARDS",
         "insightTitle":"Credit Utilization Warning (all cards)",
         "insightType":"AGGREGATE",
         "triggerType":"REFRESH",
         "container":[
            "CARD"
         ],
         "description":"Generates an insight when the balance on all credit cards is more than a configured threshold.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "userConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "threshold":[
                  {
                     "name":"UPPER_LIMIT",
                     "value":"30",
                     "type":"PERCENT"
                  }
               ]
            }
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "threshold":[
                  {
                     "name":"UPPER_LIMIT",
                     "value":"30",
                     "type":"PERCENT"
                  }
               ]
            }
         ]
      }
   ]
}

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`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Editable Parameters:

Editable Attributes	Impact	Allowed Values
isSubscribed	Subscribes or unsubscribes from the Credit Utilization Warning(all cards) insight.	true, false
threshold	The threshold (UPPER_LIMIT) can be modified to adjust the credit utilization percentage.	Any number between 1.00 and 100.00

Sample Request:

{
  "userSubscription": [
    {
      "insightName": "CREDIT_UTILIZATION_ALL_CARDS",
      "userConfiguration": [
              {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "threshold": [
                        {
                            "name": "UPPER_LIMIT",
                            "value": "30",
                            "type": "PERCENT"
                        }
                    ]
                }
         ]
    }
  ]
}

Error Messages:

HTTP Status Code	Reason
400	Y806: Invalid input
400	Y800: Invalid value for insightName
400	Y800: Invalid value for input param in CREDIT_UTILIZATION_ALL_CARDS insight
400	Y800: Invalid value for threshold data in CREDIT_UTILIZATION_ALL_CARDS insight
400	Y800: Invalid value for UPPER_LIMIT in CREDIT_UTILIZATION_ALL_CARDS insight Min = 1.00 and Max = 100.00
400	Y802: Modifying insightTitle using this API is not allowed
400	Y813: Invalid request. The entire object within threshold should be provided
400	Y802: For insight CREDIT_UTILIZATION_ALL_CARDS, modifying applicableEntity is not allowed
400	Y802: For insight CREDIT_UTILIZATION_ALL_CARDS, modifying triggerType is not allowed
400	Y802: For insight CREDIT_UTILIZATION_ALL_CARDS, modifying container is not allowed
400	Y802: For insight CREDIT_UTILIZATION_ALL_CARDS, modifying description is not allowed
400	Y802: Specifying frequency attribute for CREDIT_UTILIZATION_ALL_CARDS insight is not allowed
400	Y802: Specifying duration attribute for CREDIT_UTILIZATION_ALL_CARDS insight 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	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 CREDIT_UTILIZATION_ALL_CARDS, configurations at an entityId level are not allowed
400	Y800: Invalid value for entityType. Supported entityType for CREDIT_UTILIZATION_ALL_CARDS, 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, the Credit Utilization Warning (all cards) insight can be specifically requested.

The entityId filter does not apply to this insight.

Calculation logic for derived attributes:

totalCreditUtilizationPercent = (totalRunningBalance / totalCreditLine) * 100
totalRunningBalance = The total available balance across eligible user accounts.

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`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /insights/feed?insightName=CREDIT_UTILIZATION_ALL_CARDS

Sample Response:

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

Api-Version 3.0 and 2.1 Response

{
   "feed":[
      {
         "id":"60d43c0fe2974e643f862455",
         "insightName":"CREDIT_UTILIZATION_ALL_CARDS",
         "insightTitle":"Credit Utilization Warning (all cards)",
         "insightType":"AGGREGATE",
         "triggerType":"REFRESH",
         "createdDate":"2021-06-24T08:02:17Z",
         "subscription":[
            {
               "entityType":"ACCOUNT",
               "threshold":[
                  {
                     "name":"UPPER_LIMIT",
                     "value":"30",
                     "type":"PERCENT"
                  }
               ]
            }
         ],
         "basicCreditCardUtilizations":[
            {
               "totalCreditUtilizationPercent":54.55,
               "totalCreditLine":{
                  "amount":3000,
                  "currency":"USD"
               },
               "totalRunningBalance":{
                  "amount":1636.44,
                  "currency":"USD"
               }
            }
         ],
         "cardAccount":[
            {
               "id":10254757,
               "providerName":"Dag Site",
               "accountName":"CREDIT CARD",
               "accountType":"OTHER",
               "isAsset":false,
               "container":"creditCard",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=10254757"
               },
               "lastUpdated":"2021-06-24T08:02:01Z",
               "runningBalance":{
                  "amount":1636.44,
                  "currency":"USD"
               },
               "totalCreditLine":{
                  "amount":3000.0,
                  "currency":"USD"
               }
            }
         ]
      }
   ]
}

Api-Version 2 Response

{
   "feed":[
      {
         "id":"60d43c0fe2974e643f862455",
         "insightName":"CREDIT_UTILIZATION_ALL_CARDS",
         "insightTitle":"Credit Utilization Warning (all cards)",
         "insightType":"AGGREGATE",
         "triggerType":"REFRESH",
         "createdDate":"2021-06-24T08:02:17Z",
         "subscription":[
            {
               "entityType":"ACCOUNT",
               "threshold":[
                  {
                     "name":"UPPER_LIMIT",
                     "value":"30",
                     "type":"PERCENT"
                  }
               ]
            }
         ],
         "basicCreditCardUtilization":[
            {
               "totalCreditUtilizationPercent":54.55,
               "totalCreditLine":{
                  "amount":3000,
                  "currency":"USD"
               },
               "totalRunningBalance":{
                  "amount":1636.44,
                  "currency":"USD"
               }
            }
         ],
         "cardAccount":[
            {
               "id":10254757,
               "providerName":"Dag Site",
               "accountName":"CREDIT CARD",
               "accountType":"OTHER",
               "isAsset":false,
               "container":"creditCard",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=10254757"
               },
               "lastUpdated":"2021-06-24T08:02:01Z",
               "runningBalance":{
                  "amount":1636.44,
                  "currency":"USD"
               },
               "totalCreditLine":{
                  "amount":3000.0,
                  "currency":"USD"
               }
            }
         ]
      }
   ]
}