Financial Fees - All Accounts
Overview
The Financial Fees - All Accounts insight is a schedule-based insight that informs the user about the total expenses they incur for financial services across any of their aggregated bank and card account.
Following are the additional details for the insight:
Insight Name | FINANCIAL_FEES_ALL_ACCOUNTS |
---|---|
Applicable Entities | ACCOUNT |
Insight Type | AGGREGATE |
Trigger Type | SCHEDULE |
Supported Containers | BANK, CARD |
Use Cases
- Customer:
- User engagement
- Up-Sell / Cross-Sell opportunities - Offer lower-priced alternatives.
- User:
- Financial wellness - Uncover hidden fees.
Suggested Action
Recommend users to review their fees and speak with the respective service providers.
Duplicate Insight Checks
To prevent the same insight from generating repeatedly, the insight is generated only once per scheduled frequency for a user.
The 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:
|
|
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:
|
|
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:
|
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 provides peer benchmarking (PB) data only for the Accounts entity. Based on the segmentation parameter provided by the user, PB data is returned for the financial fees category at the peer, state, and national benchmark levels.
The default frequency and duration will be based on whether the customer has enabled or disabled the peer benchmarking feature during onboarding:
- PB enabled: The default frequency will be
MID_MONTHLY
and default duration will beLAST_THREE_MONTHS
. - PB disabled: The default frequency will be
MONTHLY
and default duration will beTHREE_MONTHS
.
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. If the customer has opted for the PB feature during onboarding, the isBenchmarkEnabled
field will be, by default, true
in the API response.
The default frequency and duration will be based on whether the customer has enabled or disabled the peer benchmarking feature during onboarding:
- PB enabled: The default frequency will be
MID_MONTHLY
and default duration will beLAST_THREE_MONTHS
. - PB disabled: The default frequency will be
MONTHLY
and default duration will beTHREE_MONTHS
.
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.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 2.1 Response
{
"customerSubscription":[
{
"insightName":"FINANCIAL_FEES_ALL_ACCOUNTS",
"insightTitle":"Financial Fees-All Accounts",
"insightType":"AGGREGATE",
"triggerType":"SCHEDULE",
"containers":[
"BANK",
"CARD"
],
"description":"Generates an insight that provides financial fee trends over a configured time period across any of the user’s account.",
"applicableEntity":[
"ACCOUNT"
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"MID_MONTHLY",
"duration":"LAST_THREE_MONTHS",
"isBenchmarkEnabled":true
}
]
}
]
}
- Api-Version 2 Response
{
"customerSubscription":[
{
"insightName":"FINANCIAL_FEES_ALL_ACCOUNTS",
"insightTitle":"Financial Fees-All Accounts",
"insightType":"AGGREGATE",
"triggerType":"SCHEDULE",
"container":[
"BANK",
"CARD"
],
"description":"Generates an insight that provides financial fee trends over a configured time period across any of the user’s account.",
"applicableEntity":[
"ACCOUNT"
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"MID_MONTHLY",
"duration":"LAST_THREE_MONTHS",
"isBenchmarkEnabled":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.
If the customer has not opted for the PB feature during onboarding, the isBenchmarkEnabled
field will be by default false
and cannot be modified. The PB feature can be opted post onboarding too.
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.1 |
|
2 |
||
Cobrand-Name |
{Name of the Customer} |
Editable Parameters:
Editable Attributes | Impact | Allowed Values |
---|---|---|
isSubscribed | Subscribes or unsubscribes all the users from the Financial Fees - All Accounts insight. | true, false |
insightTitle | The title returned in the GET feed API as well as the insights configuration tool can be changed. | Alphanumeric characters up to 100 characters (including spaces) |
frequency | The frequency at which an insight will be evaluated. |
|
duration | The data range that should be considered for evaluating the insight. |
|
isBenchmarkEnabled | If the customer has opted for the PB feature, pass the isBenchmarkEnabled as true to get the peer benchmarking data. The customer can turn OFF the PB feature by setting isBenchmarkEnabled as false . |
true, false |
Sample Request:
{
"customerSubscription": [
{
"insightName": "FINANCIAL_FEES_ALL_ACCOUNTS",
"insightTitle": "Financial Fees-All Accounts",
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MID_MONTHLY",
"duration": "LAST_THREE_MONTHS",
"isBenchmarkEnabled": true
}
]
}
]
}
Error 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 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, LAST_THREE_MONTHS, LAST_SIX_MONTHS, LAST_TWELVE_MONTHS |
400 | Y802: For insight FINANCIAL_FEES_ALL_ACCOUNTS, passing isBenchmarkEnabled is not allowed |
400 | Y800: Invalid value for isBenchmarkEnabled Supported values are true, false |
400 | Y800: Invalid value for duration. Supported values of duration for MID_MONTHLY frequency are LAST_MONTH, LAST_THREE_MONTHS, LAST_SIX_MONTHS, LAST_TWELVE_MONTHS" |
400 | Y802: Modifying isBenchmarkEnabled is not allowed |
400 | Y802: For insight FINANCIAL_FEES_ALL_ACCOUNTS, modifying applicableEntity is not allowed |
400 | Y802: For insight FINANCIAL_FEES_ALL_ACCOUNTS, modifying triggerType is not allowed |
400 | Y802: For insight FINANCIAL_FEES_ALL_ACCOUNTS, modifying container is not allowed |
400 | Y802: For insight FINANCIAL_FEES_ALL_ACCOUNTS, modifying description is not allowed |
400 | Y802: For FINANCIAL_FEES_ALL_ACCOUNTS, insight passing threshold 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 | 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 FINANCIAL_FEES_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 User Subscription
The GET user subscription API provides all the information about the user defaults set for the insight. If the customer has opted for the PB feature during onboarding, the isBenchmarkEnabled
field will be by default true
in the API response.
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.1 |
|
2 |
||
Cobrand-Name |
{Name of the Customer} |
Sample Request:
GET /insights/configs/userSubscriptions?insightName=FINANCIAL_FEES_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 2.1 Response
{
"userSubscription":[
{
"insightName":"FINANCIAL_FEES_ALL_ACCOUNTS",
"insightTitle":"Financial Fees-All Accounts",
"insightType":"AGGREGATE",
"triggerType":"SCHEDULE",
"containers":[
"BANK",
"CARD"
],
"description":"Generates an insight that provides financial fee trends over a configured time period across any of the user’s account.",
"applicableEntity":[
"ACCOUNT"
],
"userConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"MID_MONTHLY",
"duration":"LAST_THREE_MONTHS",
"isBenchmarkEnabled":true
}
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"MID_MONTHLY",
"duration":"LAST_THREE_MONTHS",
"isBenchmarkEnabled":true
}
]
}
]
}
- Api-Version 2 Response
{
"userSubscription":[
{
"insightName":"FINANCIAL_FEES_ALL_ACCOUNTS",
"insightTitle":"Financial Fees-All Accounts",
"insightType":"AGGREGATE",
"triggerType":"SCHEDULE",
"container":[
"BANK",
"CARD"
],
"description":"Generates an insight that provides financial fee trends over a configured time period across any of the user’s account.",
"applicableEntity":[
"ACCOUNT"
],
"userConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"MID_MONTHLY",
"duration":"LAST_THREE_MONTHS",
"isBenchmarkEnabled":true
}
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"MID_MONTHLY",
"duration":"LAST_THREE_MONTHS",
"isBenchmarkEnabled":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 or view, then add that account or view using the PATCH user subscription API. The customer default threshold values will apply if the user has not set any values.
If the customer has not opted for the PB feature during onboarding, the isBenchmarkEnabled
field will be by default false
and cannot be modified. The PB feature can be opted post onboarding too.
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.1 |
|
2 |
||
Cobrand-Name |
{Name of the Customer} |
Editable Parameters:
Editable Attributes | Impact | Allowed Values |
---|---|---|
isSubscribed | Subscribes or unsubscribes from the Financial Fees - All Accounts insight. | true, false |
frequency | The frequency at which an insight will be evaluated. |
|
duration | The data range that should be considered for evaluating the insight. |
|
isBenchmarkEnabled | If the customer has opted for the PB feature, pass the isBenchmarkEnabled as true to get the peer benchmarking data. The customer can turn OFF the PB feature by setting isBenchmarkEnabled as false . |
true, false |
Sample Request:
{
"userSubscription":[
{
"insightName":"FINANCIAL_FEES_ALL_ACCOUNTS",
"userConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"MID_MONTHLY",
"duration":"LAST_THREE_MONTHS",
"isBenchmarkEnabled":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 FINANCIAL_FEES_ALL_ACCOUNTS insight |
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, LAST_THREE_MONTHS, LAST_SIX_MONTHS, LAST_TWELVE_MONTHS |
400 | Y802: Modifying insightTitle using this API is not allowed |
400 | Y802: Modifying isBenchmarkEnabled is not allowed |
400 | Y802: For insight FINANCIAL_FEES_ALL_ACCOUNTS, passing isBenchmarkEnabled is not allowed |
400 | Y800: Invalid value for isBenchmarkEnabled Supported values are true, false |
400 | Y800: Invalid value for duration. Supported values of duration for MID_MONTHLY frequency are LAST_MONTH, LAST_THREE_MONTHS, LAST_SIX_MONTHS, LAST_TWELVE_MONTHS |
400 | Y802: For insight FINANCIAL_FEES_ALL_ACCOUNTS, modifying applicableEntity is not allowed |
400 | Y802: For insight FINANCIAL_FEES_ALL_ACCOUNTS, modifying triggerType is not allowed |
400 | Y802: For insight FINANCIAL_FEES_ALL_ACCOUNTS, modifying container is not allowed |
400 | Y802: For insight FINANCIAL_FEES_ALL_ACCOUNTS, modifying description is not allowed |
400 | Y802: Duplicate entityId entries within userConfiguration 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 | Y802: Duplicate entityId entries is 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 FINANCIAL_FEES_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 Financial Fees - All Accounts insight can be specifically requested.
Calculation Logic for Derived Attributes:
averageNetTotal
= netTotal
/duration
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.1 |
|
2 |
||
Cobrand-Name |
{Name of the Customer} |
Sample Request:
GET /insights/feed?insightName=FINANCIAL_FEES_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":"620e64dbaa961e561adc2818",
"insightName":"FINANCIAL_FEES_ALL_ACCOUNTS",
"insightTitle":"Financial Fees-All Accounts",
"insightType":"AGGREGATE",
"triggerType":"SCHEDULE",
"createdDate":"2022-02-17T15:08:08Z",
"subscription":[
{
"entityType":"ACCOUNT",
"frequency":"MID_MONTHLY",
"duration":"LAST_THREE_MONTHS"
}
],
"basicAccount":[
{
"id":14706496,
"providerName":"Dag Site",
"accountName":"PDV Test Data-Event",
"accountStatus":"ACTIVE",
"accountType":"CHECKING",
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=14706496"
}
},
{
"id":14706497,
"providerName":"Dag Site",
"accountName":"PDV Test Data- Account Balance",
"accountStatus":"ACTIVE",
"accountType":"SAVINGS",
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=14706497"
}
},
{
"id":14706498,
"providerName":"Dag Site",
"accountName":"PDV_Test_Data-Account_Balance",
"accountStatus":"ACTIVE",
"accountType":"SAVINGS",
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=14706498"
}
},
{
"id":14706499,
"providerName":"Dag Site",
"accountName":"PDV_Test_Data-Long_Tenure_Recurring_Payments",
"accountStatus":"ACTIVE",
"accountType":"CHECKING",
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=14706499"
}
},
{
"id":14706500,
"providerName":"Dag Site",
"accountName":"PDV Test Data- All Category",
"accountStatus":"ACTIVE",
"accountType":"OTHER",
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=14706500"
}
},
{
"id":14706495,
"providerName":"Dag Site",
"accountName":"PDV_Test_Data_Sch/Ref",
"accountStatus":"ACTIVE",
"accountType":"CHECKING",
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=14706495"
}
}
],
"basicTrend":[
{
"dateRange":{
"fromDate":"2021-11-01",
"toDate":"2022-01-31"
},
"categoryTrend":[
{
"categoryId":24,
"category":"Service Charges/Fees",
"debitTotal":{
"amount":7257.0,
"currency":"USD"
},
"creditTotal":{
"amount":0.0,
"currency":"USD"
},
"netTotal":{
"amount":7257.0,
"currency":"USD"
},
"averageNetTotal":{
"amount":7257.0,
"currency":"USD"
},
"link":{
"entityName":"transaction",
"url":"/derived/transactions?fromDate=2021-11-01&toDate=2022-01-31&categoryId=24&accountId=14706496,14706497,14706498,14706499,14706500,14706495"
},
"basicPeerDetail":{
"dateRange":{
"fromDate":"2021-11-01",
"toDate":"2022-01-31"
},
"benchmarkAsOf":"Jan-2022",
"benchmark":[
{
"geo":{
"level":"national",
"value":"US"
},
"benchmarkLevel":"national",
"netTotal":{
"amount":42,
"currency":"USD"
},
"numberOfPeers":3703515
}
]
},
"detail":[
{
"dateRange":{
"fromDate":"2022-01-01",
"toDate":"2022-01-31"
},
"debitTotal":{
"amount":3315.5,
"currency":"USD"
},
"creditTotal":{
"amount":0.0,
"currency":"USD"
},
"netTotal":{
"amount":3315.5,
"currency":"USD"
},
"link":{
"entityName":"transaction",
"url":"/derived/transactions?fromDate=2022-01-01&toDate=2022-01-31&categoryId=24&accountId=14706496,14706497,14706498,14706499,14706500,14706495"
}
},
{
"dateRange":{
"fromDate":"2021-12-01",
"toDate":"2021-12-31"
},
"debitTotal":{
"amount":3315.5,
"currency":"USD"
},
"creditTotal":{
"amount":0.0,
"currency":"USD"
},
"netTotal":{
"amount":3315.5,
"currency":"USD"
},
"link":{
"entityName":"transaction",
"url":"/derived/transactions?fromDate=2021-12-01&toDate=2021-12-31&categoryId=24&accountId=14706496,14706497,14706498,14706499,14706500,14706495"
}
},
{
"dateRange":{
"fromDate":"2021-11-01",
"toDate":"2021-11-30"
},
"debitTotal":{
"amount":626.0,
"currency":"USD"
},
"creditTotal":{
"amount":0.0,
"currency":"USD"
},
"netTotal":{
"amount":626.0,
"currency":"USD"
},
"link":{
"entityName":"transaction",
"url":"/derived/transactions?fromDate=2021-11-01&toDate=2021-11-30&categoryId=24&accountId=14706496,14706497,14706498,14706499,14706500,14706495"
}
}
]
}
]
}
]
}
]
}