Large Purchase - All Accounts

Overview

The Large Purchase- All Accounts insight is a schedule-triggered insight that looks for expense transactions above a user-defined threshold. Based on the user-defined frequency, all the transactions that match the criteria will be used to generate the insight.

Following are the additional details for the insight:

Insight Name	LARGE_PURCHASE_ALL_ACCOUNTS
Applicable Entity	ACCOUNT
Insight Type	AGGREGATE
Trigger Type	SCHEDULE
Supported Containers	BANK, CARD

Use Cases

Customer:
- User engagement
User:
- Financial wellness - Keep a track of spending across users' accounts.

Suggested Action

Suggest the user to create a VIEW based on the overspending categories, set a budget, and track spending.

Duplicate Insight Checks

To prevent the same insight from generating repeatedly, the insight is generated only once per scheduled frequency for a user.

Following are the applicable frequencies for this insight:

Frequency	Description
DAILY	The insight will be triggered daily. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current day from 12:00 AM same day to the time of insight evaluation.
WEEKLY	The insight will be triggered once every Monday. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current calendar week (Monday to Sunday). For example: Normal scenario: If the calendar week starts from 1st January to 7th January, the insight is triggered on 1st January. Dynamic trigger scenario: If the calendar week starts from 1st January to 7th January, and the user triggers an insight on 3rd January using dynamic trigger, duplicate check happens from 1st January to 3rd January.
MONTHLY	The insight will be triggered once on the first day of the calendar month. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current calendar month (1st of the calendar month to the last day of the month). For example: Normal scenario: If the calendar month starts from 1st January to 31st January, the insight is triggered on 1st January. Dynamic trigger scenario: If the calendar month starts from 1st January to 31st January, and the user triggers an insight on 3rd January using dynamic trigger, duplicate check happens from 1st January to 3rd January.
MID_MONTHLY	The insight will be triggered once on the 16th of a calendar month. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current calendar month (1st of the calendar month to the last day of the month). For example: Normal scenario: If the calendar month starts from 1st January, the insight is triggered on 16th of January. Dynamic trigger scenario: If the calendar month starts from 1st January, and the user triggers an insight on 3rd January using dynamic trigger, duplicate check happens from 1st January to 3rd January.

Insight Dynamic Trigger (On-Demand Evaluation)

The insight can be triggered using the following on-demand insight trigger API:

POST /insights/trigger

Peer Benchmarking Data

This insight does not provide peer benchmarking data.

Thresholds

Threshold lets the customer or the user decide when the user has to be alerted about a deposit in an account. If the deposit amount is more than the threshold configured, an insight is generated for the user.

Threshold Name: MINIMUM
Data Type: AMOUNT
Range Allowed: 1.00 <= CHANGE <= 1000000.00
Default: 500.00

Note: Only USD currency is currently supported. Depending on the customer segment and account, 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. The default frequency for the insight is MONTHLY and the default duration for the insight is LAST_MONTH.

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":"LARGE_PURCHASE_ALL_ACCOUNTS",
         "insightTitle":"Large Purchase - All Accounts",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "containers":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight when a purchase is made that is more than a configured threshold across any of the user’s account.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"MONTHLY",
               "duration":"LAST_MONTH",
               "threshold":[
                  {
                     "name":"MINIMUM",
                     "value":"500",
                     "type":"AMOUNT"
                  }
               ]
            }
         ]
      }
   ]
}

Api-Version 2 Response

{
   "customerSubscription":[
      {
         "insightName":"LARGE_PURCHASE_ALL_ACCOUNTS",
         "insightTitle":"Large Purchase - All Accounts",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "container":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight when a purchase is made that is more than a configured threshold across any of the user’s account.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"MONTHLY",
               "duration":"LAST_MONTH",
               "threshold":[
                  {
                     "name":"MINIMUM",
                     "value":"500",
                     "type":"AMOUNT"
                  }
               ]
            }
         ]
      }
   ]
}

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 Large Purchase- All Accounts 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)
frequency	The frequency at which an insight will be evaluated.	DAILY (Every day - Early Morning) WEEKLY (every Monday - early morning) MONTHLY (1st of every month - early morning) MID_MONTHLY (16th of every month - early morning)
duration	The data range that should be considered for evaluating the insight.	THIS_MONTH LAST_MONTH THREE_MONTHS (Current Month + Last 2 Months) SIX_MONTHS (Current Month + Last 5 Months) ONE_YEAR (Current Month + Last 11 Months)
threshold	The threshold value (MINIMUM AMOUNT) for generating the Large Purchase- All Accounts insight can be changed.	Any number between 1.00 and 1000000.00.

Sample Request:

{
   "customerSubscription":[
      {
         "insightName":"LARGE_PURCHASE_ALL_ACCOUNTS",
         "insightTitle":"Large Purchase - All Accounts",
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"MONTHLY",
               "duration":"LAST_MONTH",
               "threshold":[
                  {
                     "name":"MINIMUM",
                     "value":"500",
                     "type":"AMOUNT"
                  }
               ]
            }
         ]
      }
   ]
}

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 MINIMUM in LARGE_PURCHASE_ALL_ACCOUNTS insight Min = 1.00 and Max = 1000000.00
400	Y813: Invalid request. The entire object within threshold should be provided
400	Y802: For insight LARGE_PURCHASE_ALL_ACCOUNTS, modifying applicableEntity is not allowed
400	Y802: For insight LARGE_PURCHASE_ALL_ACCOUNTS, modifying triggerType is not allowed
400	Y802: For insight LARGE_PURCHASE_ALL_ACCOUNTS, modifying container is not allowed
400	Y802: For insight LARGE_PURCHASE_ALL_ACCOUNTS, 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	Y800: Invalid value for frequency; Supported values are DAILY, WEEKLY, MONTHLY, MID_MONTHLY
400	Y800: Invalid value for duration; Supported values are THIS_MONTH, LAST_MONTH, THREE_MONTHS, SIX_MONTHS, ONE_YEAR
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 LARGE_PURCHASE_ALL_ACCOUNTS insight are - [ACCOUNT]
400	Y802: For LARGE_PURCHASE_ALL_ACCOUNTS insight, {Invalid String} inside the threshold is either repeated or not allowed
400	Y802: For LARGE_PURCHASE_ALL_ACCOUNTS 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 is not applicable for 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=LARGE_PURCHASE_ALL_ACCOUNTS

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":"LARGE_PURCHASE_ALL_ACCOUNTS",
         "insightTitle":"Large Purchase - All Accounts",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "containers":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight when a purchase is made that is more than a configured threshold across any of the user’s account.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "userConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"MONTHLY",
               "duration":"LAST_MONTH",
               "threshold":[
                  {
                     "name":"MINIMUM",
                     "value":"500",
                     "type":"AMOUNT"
                  }
               ]
            }
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"MONTHLY",
               "duration":"LAST_MONTH",
               "threshold":[
                  {
                     "name":"MINIMUM",
                     "value":"500",
                     "type":"AMOUNT"
                  }
               ]
            }
         ]
      }
   ]
}

Api-Version 2 Response

{
   "userSubscription":[
      {
         "insightName":"LARGE_PURCHASE_ALL_ACCOUNTS",
         "insightTitle":"Large Purchase - All Accounts",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "container":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight when a purchase is made that is more than a configured threshold across any of the user’s account.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "userConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"MONTHLY",
               "duration":"LAST_MONTH",
               "threshold":[
                  {
                     "name":"MINIMUM",
                     "value":"500",
                     "type":"AMOUNT"
                  }
               ]
            }
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"MONTHLY",
               "duration":"LAST_MONTH",
               "threshold":[
                  {
                     "name":"MINIMUM",
                     "value":"500",
                     "type":"AMOUNT"
                  }
               ]
            }
         ]
      }
   ]
}

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 Large Purchase- All Accounts insight.	true, false
frequency	The frequency at which an insight will be evaluated.	DAILY (Every day - Early Morning) WEEKLY (every Monday - early morning) MONTHLY (1st of every month - early morning) MID_MONTHLY (16th of every month - early morning)
duration	The data range that should be considered for evaluating the insight.	THIS_MONTH LAST_MONTH THREE_MONTHS (Current Month + Last 2 Months) SIX_MONTHS (Current Month + Last 5 Months) ONE_YEAR (Current Month + Last 11 Months)
threshold	The threshold value (MINIMUM AMOUNT) for generating the Large Purchase- All Accounts insight can be changed.	Any number between 1.00 and 1000000.00.

Sample Request:

{
   "userSubscription":[
      {
         "insightName":"LARGE_PURCHASE_ALL_ACCOUNTS",
         "userConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"MONTHLY",
               "duration":"LAST_MONTH",
               "threshold":[
                  {
                     "name":"MINIMUM",
                     "value":"500",
                     "type":"AMOUNT"
                  }
               ]
            }
         ]
      }
   ]
}

Error Messages:

HTTP Status Code	Reason
400	Y806: Invalid input
400	Y800: Invalid value for insightName
400	Y800: Invalid value for input param in LARGE_PURCHASE_ALL_ACCOUNTS insight
400	Y800: Invalid value for threshold data in LARGE_PURCHASE_ALL_ACCOUNTS insight
400	Y800: Invalid value for MINIMUM in LARGE_PURCHASE_ALL_ACCOUNTS insight Min = 1.00 and Max = 1000000.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 LARGE_PURCHASE_ALL_ACCOUNTS, modifying applicableEntity is not allowed
400	Y802: For insight LARGE_PURCHASE_ALL_ACCOUNTS, modifying triggerType is not allowed
400	Y802: For insight LARGE_PURCHASE_ALL_ACCOUNTS, modifying container is not allowed
400	Y802: For insight LARGE_PURCHASE_ALL_ACCOUNTS, modifying description is not allowed
400	Y800: Invalid value for frequency; Supported values are DAILY, WEEKLY, MONTHLY, MID_MONTHLY
400	Y800: Invalid value for duration; Supported values are THIS_MONTH, LAST_MONTH, THREE_MONTHS, SIX_MONTHS, ONE_YEAR
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	Y802: For insight LARGE_PURCHASE_ALL_ACCOUNTS, configurations at an entityId level are not allowed
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	Y800: Invalid value for entityType. Supported entityType for LARGE_PURCHASE_ALL_ACCOUNTS 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 Large Purchase- All Accounts insight can be specifically requested.

The entityId filter is not applicable for 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`	`3.0`
	`2.1`
	`2`
`Cobrand-Name`	`{Name of the Customer}`

Sample Request:

GET /insights/feed?insightName=LARGE_PURCHASE_ALL_ACCOUNTS

Sample Response:

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

{
   "feed":[
      {
         "id":"619b15c2227dae632e7da74d",
         "insightName":"LARGE_PURCHASE_ALL_ACCOUNTS",
         "insightTitle":"Large Purchase - All Accounts",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "createdDate":"2021-11-22T04:00:02Z",
         "subscription":[
            {
               "entityType":"ACCOUNT",
               "frequency":"MONTHLY",
               "duration":"THREE_MONTHS",
               "threshold":[
                  {
                     "name":"MINIMUM",
                     "value":"500.00",
                     "type":"AMOUNT"
                  }
               ]
            }
         ],
         "basicAccount":[
            {
               "id":14278021,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data-Event",
               "accountType":"CHECKING",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=14278021"
               },
               "basicTransaction":[
                  {
                     "id":51062452,
                     "amount":{
                        "amount":2999.00,
                        "currency":"USD"
                     },
                     "date":"2021-11-20",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=51062452"
                     },
                     "categoryId":7,
                     "category":"Entertainment",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "original":"NetFlix Payment",
                        "simple":"Netflix"
                     },
                     "sourceType":"AGGREGATED",
                     "merchantType":"SUBSCRIPTION",
                     "basicMerchant":{
                        "name":"Netflix"
                     }
                  },
                  {
                     "id":51061931,
                     "amount":{
                        "amount":3500.00,
                        "currency":"USD"
                     },
                     "date":"2021-10-26",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=51061931"
                     },
                     "categoryId":10,
                     "category":"Groceries",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "original":"Education expenses",
                        "simple":"Education expenses"
                     },
                     "sourceType":"AGGREGATED",
                     "merchantType":"OTHERS"
                  },
                  {
                     "id":51061932,
                     "amount":{
                        "amount":3500.00,
                        "currency":"USD"
                     },
                     "date":"2021-09-26",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=51061932"
                     },
                     "categoryId":10,
                     "category":"Groceries",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "original":"Education expenses",
                        "simple":"Education expenses"
                     },
                     "sourceType":"AGGREGATED",
                     "merchantType":"OTHERS"
                  }
               ]
            },
            {
               "id":14278020,
               "providerName":"Dag Site",
               "accountName":"PDV_Test_Data_Sch/Ref",
               "accountType":"CHECKING",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=14278020"
               },
               "basicTransaction":[
                  {
                     "id":51061846,
                     "amount":{
                        "amount":500.18,
                        "currency":"USD"
                     },
                     "date":"2021-11-19",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=51061846"
                     },
                     "categoryId":44,
                     "category":"General Merchandise",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "original":"AMAZON Purchase",
                        "simple":"Amazon"
                     },
                     "sourceType":"AGGREGATED",
                     "merchantType":"OTHERS",
                     "basicMerchant":{
                        "name":"Amazon"
                     }
                  },
                  {
                     "id":51061843,
                     "amount":{
                        "amount":500.18,
                        "currency":"USD"
                     },
                     "date":"2021-11-19",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=51061843"
                     },
                     "categoryId":8,
                     "category":"Gasoline/Fuel",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "original":"SHELL OIL",
                        "simple":"Shell"
                     },
                     "sourceType":"AGGREGATED",
                     "merchantType":"OTHERS",
                     "basicMerchant":{
                        "name":"Shell"
                     }
                  },
                  {
                     "id":51061910,
                     "amount":{
                        "amount":500.18,
                        "currency":"USD"
                     },
                     "date":"2021-11-05",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=51061910"
                     },
                     "categoryId":8,
                     "category":"Gasoline/Fuel",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "original":"SHELL OIL",
                        "simple":"Shell"
                     },
                     "sourceType":"AGGREGATED",
                     "merchantType":"OTHERS",
                     "basicMerchant":{
                        "name":"Shell"
                     }
                  },
                  {
                     "id":51061906,
                     "amount":{
                        "amount":500.18,
                        "currency":"USD"
                     },
                     "date":"2021-11-05",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=51061906"
                     },
                     "categoryId":44,
                     "category":"General Merchandise",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "original":"Walmart Payment",
                        "simple":"Walmart"
                     },
                     "sourceType":"AGGREGATED",
                     "merchantType":"OTHERS",
                     "basicMerchant":{
                        "name":"Walmart"
                     }
                  }
               ]
            }
         ]
      }
   ]
}