Bill Paid

Overview

The Bill Paid insight is an event-triggered insight that alerts the user when a recurring bill is paid successfully.

The insight for VIEW is generated only if the VIEW rule contains merchantType as a BILLER. For VIEW insights, only EXPENSE rules are considered.

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

Following are the additional details for the insight:

Insight Name BILL_PAID
Applicable Entities ACCOUNT, VIEW
Insight Type OTHER
Trigger Type EVENT
Supported Containers BANK, CARD

Use Cases

  • Customer:
    • User engagement
  • User:
    • Financial discipline - Keep bill spending under check

Suggested Action

Recommend the user to stick to a fixed payment schedule.

Duplicate Insight Checks

To prevent the same insight from generating repeatedly, the insight is generated once every 31 days (including the date of insight evaluation) for each of the applicable transaction ID for each recurring event (bill instance) per entity ID.

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":"BILL_PAID",
         "insightTitle":"Bill Paid",
         "insightType":"OTHER",
         "triggerType":"EVENT",
         "container":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight when a recurring bill is paid.",
         "applicableEntity":[
            "ACCOUNT",
            "VIEW"
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true
            },
            {
               "entityType":"VIEW",
               "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 Bill Paid 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)

Sample Request:

{
    "customerSubscription": [
        {
            "insightName": "BILL_PAID",
            "insightTitle": "Bill Paid",
            "customerConfiguration": [
                {
                    "entityType": "ACCOUNT",
                    "isSubscribed": true
                },
                {
                    "entityType": "VIEW",
                    "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 BILL_PAID, modifying applicableEntity is not allowed
400 Y802: For insight BILL_PAID, modifying triggerType is not allowed
400 Y802: For insight BILL_PAID, modifying container is not allowed
400 Y802: For insight BILL_PAID, 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 BILL_PAID insight is not allowed
400 Y802: Specifying duration attribute for BILL_PAID insight is not allowed
400 Y802: For BILL_PAID 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 BILL_PAID insight are - [ACCOUNT, VIEW]
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 2
Cobrand-Name {Name of the Customer}

Sample Request:

/insights/configs/userSubscriptions?insightName=BILL_PAID

Sample Response:

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

{
   "userSubscription":[
      {
         "insightName":"BILL_PAID",
         "insightTitle":"Bill Paid",
         "insightType":"OTHER",
         "triggerType":"EVENT",
         "container":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight when a recurring bill is paid.",
         "applicableEntity":[
            "ACCOUNT",
            "VIEW"
         ],
         "userConfiguration":[
            {
               "entityType":"ACCOUNT",
               "entityId": "10255809",
               "isSubscribed":true
            },
            {
               "entityType":"VIEW",
               "isSubscribed":true
            }
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true
            },
            {
               "entityType":"VIEW",
               "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 or a new 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.

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
entityId The ID of the account or view for which bill gets evaluated. Valid IDs for accounts or views belonging to the user.
isSubscribed Subscribes or unsubscribes from the Bill Paid insight. true, false

Sample Request:

{
   "userSubscription":[
      {
         "insightName":"BILL_PAID",
         "userConfiguration":[
            {
               "entityType":"ACCOUNT",
               "entityId": "10255809",
               "isSubscribed":true
            },
            {
               "entityType":"VIEW",
               "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 BILL_PAID insight
400 Y800: Invalid value for entityId; This id is either invalid or not supported for this insight.
400 Y802: Duplicate entityId entries is not allowed 
400 Y802: Modifying insightTitle using this API is not allowed
400 Y802: For insight BILL_PAID, modifying applicableEntity is not allowed
400 Y802: For insight BILL_PAID, modifying triggerType is not allowed
400 Y802: For insight BILL_PAID, modifying container is not allowed
400 Y802: For insight BILL_PAID, modifying description is not allowed
400 Y802: Duplicate entityId entries within userConfiguration is not allowed
400 Y802: Specifying frequency attribute for BILL_PAID insight is not allowed
400 Y802: Specifying duration attribute for BILL_PAID 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 Y802: For BILL_PAID insight passing threshold is not allowed
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 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 BILL_PAID insight are - [ACCOUNT, VIEW]
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 Bill Paid insight only.

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

Sample Response:

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

{
   "feed":[
      {
         "id":"60d43ad9e2974e643f862416",
         "insightName":"BILL_PAID",
         "insightTitle":"Bill Paid",
         "insightType":"OTHER",
         "triggerType":"EVENT",
         "createdDate":"2021-06-24T07:57:11Z",
         "subscription":[
            {
               "entityId":"60d439b2ad07551c02b06dc0",
               "entityType":"VIEW"
            }
         ],
         "basicView":[
            {
               "id":"60d439b2ad07551c02b06dc0",
               "name":"View 1",
               "link":{
                  "entityName":"view",
                  "url":"/views/60d439b2ad07551c02b06dc0"
               },
               "basicAccount":[
                  {
                     "id":10254749,
                     "providerName":"Dag Site",
                     "accountName":"PDV Test Data-Event",
                     "accountType":"CHECKING",
                     "isAsset":true,
                     "container":"bank",
                     "link":{
                        "entityName":"account",
                        "url":"/accounts?accountId=10254749"
                     },
                     "basicTransaction":[
                        {
                           "id":12713721,
                           "amount":{
                              "amount":99999.76,
                              "currency":"USD"
                           },
                           "date":"2021-06-24",
                           "link":{
                              "entityName":"transaction",
                              "url":"/derived/transactions?transactionId=12713721"
                           },
                           "categoryId":39,
                           "category":"Utilities",
                           "baseType":"DEBIT",
                           "description":{
                              "original":"Duke Energy FL Bill Payment",
                              "simple":"Duke Energy FL"
                           },
                           "sourceType":"AGGREGATED",
                           "merchantType":"BILLERS",
                           "basicMerchant":{
                              "name":"Duke Energy"
                           }
                        }
                     ]
                  }
               ]
            }
         ]
      },
      {
         "id":"60d43ad9e2974e643f862413",
         "insightName":"BILL_PAID",
         "insightTitle":"Bill Paid",
         "insightType":"OTHER",
         "triggerType":"EVENT",
         "createdDate":"2021-06-24T07:57:11Z",
         "subscription":[
            {
               "entityId":"10254749",
               "entityType":"ACCOUNT"
            }
         ],
         "basicAccount":[
            {
               "id":10254749,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data-Event",
               "accountType":"CHECKING",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=10254749"
               },
               "basicTransaction":[
                  {
                     "id":12713724,
                     "amount":{
                        "amount":4.0,
                        "currency":"USD"
                     },
                     "date":"2021-06-24",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=12713724"
                     },
                     "categoryId":15,
                     "category":"Cable/Satellite Services",
                     "baseType":"DEBIT",
                     "description":{
                        "original":"BILL PAY COMCAST CABLE CO ON-LINE xxxxxxxxxxx00000 ON 00-00",
                        "simple":"COMCAST CABLE CO ON-LINE XX0000 ON x0-00"
                     },
                     "sourceType":"AGGREGATED",
                     "merchantType":"BILLERS",
                     "basicMerchant":{
                        "name":"Comcast"
                     }
                  }
               ]
            }
         ]
      }
   ]
}