Projected Discretionary Funds

Overview

The Projected Discretionary Funds insight is a schedule-trigger insight that projects the discretionary funds available for the current month. Discretionary funds are funds available for the user to spend, calculated taking into account all the predicted income, predicted expense, and current available balance for the account.

The Predicted Cash Flow feature should be enabled as a pre-requisite for this insight.

Following are the additional details for the insight:

Insight Name	PROJECTED_DISCRETIONARY_FUNDS
Applicable Entity	ACCOUNT
Insight Type	OTHER
Trigger Type	SCHEDULE
Supported Container	BANK

Use Cases

Customer:
- User engagement
- Cross-Sell / Up-Sell opportunity - Prompt users to move money extra money to any of the FI's investment offerings.
User:
- Financial discipline - Know how much the users can spend on wants.

Suggested Action

Depending on the discretionary funds available, suggest suitable short-term investment options that might fetch higher returns.

Duplicate Insight Checks

To prevent the same insight from generating repeatedly, the insight is generated once per frequency cycle for each of the applicable entity ID.

Following is the applicable frequency for this insight:

Frequency	Description
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.

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 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. The default frequency for the insight is MONTHLY and the default duration for the insight is ENTIRE_THIS_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": "PROJECTED_DISCRETIONARY_FUNDS",
            "insightTitle": "Projected Discretionary Funds",
            "insightType": "OTHER",
            "triggerType": "SCHEDULE",
            "containers": [
                "BANK"
            ],
            "description": "Generates an insight that projects the discretionary funds available for the current month.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "ENTIRE_THIS_MONTH"
                }
            ]
        }
   ]
}

Api-Version 2 Response

{
   "customerSubscription":[
    {
            "insightName": "PROJECTED_DISCRETIONARY_FUNDS",
            "insightTitle": "Projected Discretionary Funds",
            "insightType": "OTHER",
            "triggerType": "SCHEDULE",
            "container": [
                "BANK"
            ],
            "description": "Generates an insight that projects the discretionary funds available for the current month.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "ENTIRE_THIS_MONTH"
                }
            ]
        }
   ]
}

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 Projected Discretionary Funds 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)

Sample Request:

{
    "customerSubscription": [
        {
            "insightName": "PROJECTED_DISCRETIONARY_FUNDS",
            "insightTitle": "Projected Discretionary Funds",
            "customerConfiguration": [
                {
                    "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 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 PROJECTED_DISCRETIONARY_FUNDS, modifying frequency is not allowed
400	Y802: For insight PROJECTED_DISCRETIONARY_FUNDS, modifying duration is not allowed
400	Y802: For PROJECTED_DISCRETIONARY_FUNDS insight passing threshold is not allowed
400	Y802: For insight PROJECTED_DISCRETIONARY_FUNDS, modifying applicableEntity is not allowed
400	Y802: For insight PROJECTED_DISCRETIONARY_FUNDS, modifying triggerType is not allowed
400	Y802: For insight PROJECTED_DISCRETIONARY_FUNDS, modifying container is not allowed
400	Y802: For insight PROJECTED_DISCRETIONARY_FUNDS, 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	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 PROJECTED_DISCRETIONARY_FUNDS 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.

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=PROJECTED_DISCRETIONARY_FUNDS

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": "PROJECTED_DISCRETIONARY_FUNDS",
            "insightTitle": "Projected Discretionary Funds",
            "insightType": "OTHER",
            "triggerType": "SCHEDULE",
            "containers": [
                "BANK"
            ],
            "description": "Generates an insight that projects the discretionary funds available for the current month.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "entityId": "13709587",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "ENTIRE_THIS_MONTH"
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "ENTIRE_THIS_MONTH"
                }
            ]
        }
   ]
}

Api-Version 2 Response

{
   "userSubscription":[
            "insightName": "PROJECTED_DISCRETIONARY_FUNDS",
            "insightTitle": "Projected Discretionary Funds",
            "insightType": "OTHER",
            "triggerType": "SCHEDULE",
            "container": [
                "BANK"
            ],
            "description": "Generates an insight that projects the discretionary funds available for the current month.",
            "applicableEntity": [
                "ACCOUNT"
            ],
            "userConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "entityId": "13709587",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "ENTIRE_THIS_MONTH"
                }
            ],
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true,
                    "frequency": "MONTHLY",
                    "duration": "ENTIRE_THIS_MONTH"
                }
            ]
        }
   ]
}

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
entityId	The ID of the account for which the insight is generated.	Valid IDs for accounts belonging to the user
isSubscribed	Subscribes or unsubscribes from the Projected Discretionary Funds insight.	true, false

Sample Request:

{
   "userSubscription":[
      {
         "insightName":"PROJECTED_DISCRETIONARY_FUNDS",
         "userConfiguration":[
            {
               "entityType": "ACCOUNT",
               "entityId": "13709587",
               "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 PROJECTED_DISCRETIONARY_FUNDS insight
400	Y802: For insight PROJECTED_DISCRETIONARY_FUNDS, modifying frequency is not allowed
400	Y802: For insight PROJECTED_DISCRETIONARY_FUNDS, modifying duration is not allowed
400	Y800: Invalid value for entityId; This id is either invalid or not supported for this insight.
400	Y802: For PROJECTED_DISCRETIONARY_FUNDS insight passing threshold is not allowed
400	Y802: Modifying insightTitle using this API is not allowed
400	Y802: For insight PROJECTED_DISCRETIONARY_FUNDS, modifying applicableEntity is not allowed
400	Y802: For insight PROJECTED_DISCRETIONARY_FUNDS, modifying triggerType is not allowed
400	Y802: For insight PROJECTED_DISCRETIONARY_FUNDS, modifying container is not allowed
400	Y802: For insight PROJECTED_DISCRETIONARY_FUNDS, 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	Y800: Invalid value for userConfiguration; entityId should be provided.
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 PROJECTED_DISCRETIONARY_FUNDS 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 Projected Discretionary Funds insight. The insight will be generated only if the discretionaryBalance is greater than 0.

Calculation Logic for Derived Attributes:

balancePlaceholder =
- Available balance, if available balance > 0
- Balance, if available balance = 0 or not available & balance > 0
- Available balance, if available balance = balance = 0
predictedBalance = balancePlaceholder + predictedIncome – predictedExpense
where
- predictedIncome = Sum of all predicted income for the duration
- predictedExpense = Sum of all predicted expenses for the duration
discretionaryBalance = predictedBalance + Adjustment Factor
where Adjustment Factor is calculated using following steps:
1. Identify the debitTotal for each of the last six months
2. Identify how many months(N) have debitTotal > 0
  - If N = 0, set adjustment factor = 0
  - If N >= 1, take the sum of all debitTotal and divide by N; consider this as averageDebitTotal
    - Calculate difference = averageDebitTotal - predictedExpense
      - If difference = 0, set adjustment factor = 0
      - If difference > 0, set adjustment factor = difference
      - If difference < 0, set adjustment factor = 0

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=PROJECTED_DISCRETIONARY_FUNDS

Sample Response:

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

{
   "feed":[
      {
         "id":"61f200c85fa1a2410b0f912f",
         "insightName":"PROJECTED_DISCRETIONARY_FUNDS",
         "insightTitle":"Projected Discretionary Funds",
         "insightType":"OTHER",
         "triggerType":"SCHEDULE",
         "createdDate":"2022-01-27T02:17:44Z",
         "subscription":[
            {
               "entityId":"14568113",
               "entityType":"ACCOUNT",
               "frequency":"MONTHLY",
               "duration":"ENTIRE_THIS_MONTH"
            }
         ],
         "bankAccount":[
            {
               "id":14568113,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data- Account Balance",
               "accountType":"SAVINGS",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=14568113"
               },
               "availableBalance":{
                  "amount":5.0,
                  "currency":"USD"
               },
               "currentBalance":{
                  "amount":5.0,
                  "currency":"USD"
               },
               "balance":{
                  "amount":5.0,
                  "currency":"USD"
               },
               "lastUpdated":"2022-01-26T17:01:57Z",
               "predictedInfo":{
                  "dateRange":{
                     "fromDate":"2022-01-01T00:00:00",
                     "toDate":"2022-01-31T23:59:59"
                  },
                  "predictedBalance":{
                     "amount":5.0,
                     "currency":"USD"
                  },
                  "predictedDiscretionaryBalance":{
                     "amount":5.0,
                     "currency":"USD"
                  }
               },
               "accountStatus":"ACTIVE"
            }
         ]
      }
   ]
}