Long Tenure Recurring Payments
Overview
The Long Tenure Recurring Payments insight is a schedule-triggered insight that tracks all the top bills and subscriptions for a user based on the oldest recurring bills/subscription first.
Following are the additional details for the insight:
| Insight Name | LONG_TENURE_RECURRING_PAYMENTS |
|---|---|
| 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 and cancel any unwanted subscriptions.
Suggested Action
Suggest the user to review the recurring billers and subscriptions and cancel anything that the user might not need anymore.
Duplicate Insight Checks
To prevent the same insight from generating repeatedly, the insight is generated only once per scheduled frequency for a user.
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:
|
|
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 the long-tenured recurring payments.
- Threshold Name: TOP
- Data Type: NUMBER
- Range Allowed: 1 <= TOP <= 100
- Default: 5
Note: 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.
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": "LONG_TENURE_RECURRING_PAYMENTS",
"insightTitle": "Long Tenure Recurring Payments",
"insightType": "AGGREGATE",
"triggerType": "SCHEDULE",
"containers": [
"BANK",
"CARD"
],
"description": "Generates an insight that lists long-tenured recurring payments.",
"applicableEntity": [
"ACCOUNT"
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"threshold": [
{
"name": "TOP",
"value": "5",
"type": "NUMBER"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"customerSubscription":[
{
"insightName": "LONG_TENURE_RECURRING_PAYMENTS",
"insightTitle": "Long Tenure Recurring Payments",
"insightType": "AGGREGATE",
"triggerType": "SCHEDULE",
"container": [
"BANK",
"CARD"
],
"description": "Generates an insight that lists long-tenured recurring payments.",
"applicableEntity": [
"ACCOUNT"
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"threshold": [
{
"name": "TOP",
"value": "5",
"type": "NUMBER"
}
]
}
]
}
]
}
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.1 |
|
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Editable Parameters:
| Editable Attributes | Impact | Allowed Values |
|---|---|---|
| isSubscribed | Subscribes or unsubscribes all the users from the Long Tenure Recurring Payments 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) |
| threshold | The threshold (TOP) can be modified. | Any number between 1 to 100. |
Sample Request:
{
"customerSubscription": [
{
"insightName": "LONG_TENURE_RECURRING_PAYMENTS",
"customerConfiguration": [
{
"isSubscribed": true,
"entityType": "ACCOUNT",
"threshold": [
{
"name": "TOP",
"type": "NUMBER",
"value": "5"
}
]
}
]
}
]
}
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 LONG_TENURE_RECURRING_PAYMENTS, modifying frequency is not allowed |
| 400 | Y802: Specifying duration attribute for LONG_TENURE_RECURRING_PAYMENTS insight is not allowed |
| 400 | Y800: Invalid value for TOP in LONG_TENURE_RECURRING_PAYMENTS insight Min =1 and Max = 100 |
| 400 | Y813: Invalid request. The entire object within threshold should be provided |
| 400 | Y802: For insight LONG_TENURE_RECURRING_PAYMENTS, modifying applicableEntity is not allowed |
| 400 | Y802: For insight LONG_TENURE_RECURRING_PAYMENTS, modifying triggerType is not allowed |
| 400 | Y802: For insight LONG_TENURE_RECURRING_PAYMENTS, modifying container is not allowed |
| 400 | Y802: For insight LONG_TENURE_RECURRING_PAYMENTS, 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 LONG_TENURE_RECURRING_PAYMENTS insight are - [ACCOUNT] |
| 400 | Y802: For LONG_TENURE_RECURRING_PAYMENTS insight, {Invalid String} inside the threshold is either repeated or not allowed |
| 400 | Y802: For LONG_TENURE_RECURRING_PAYMENTS 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 |
2.1 |
|
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Sample Request:
GET /insights/configs/userSubscriptions?insightName=LONG_TENURE_RECURRING_PAYMENTS
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": "LONG_TENURE_RECURRING_PAYMENTS",
"insightTitle": "Long Tenure Recurring Payments",
"insightType": "AGGREGATE",
"triggerType": "SCHEDULE",
"containers": [
"BANK",
"CARD"
],
"description": "Generates an insight that lists long-tenured recurring payments.",
"applicableEntity": [
"ACCOUNT"
],
"userConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"threshold": [
{
"name": "TOP",
"value": "5",
"type": "NUMBER"
}
]
}
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"threshold": [
{
"name": "TOP",
"value": "5",
"type": "NUMBER"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"userSubscription":[
{
"insightName": "LONG_TENURE_RECURRING_PAYMENTS",
"insightTitle": "Long Tenure Recurring Payments",
"insightType": "AGGREGATE",
"triggerType": "SCHEDULE",
"container": [
"BANK",
"CARD"
],
"description": "Generates an insight that lists long-tenured recurring payments.",
"applicableEntity": [
"ACCOUNT"
],
"userConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"threshold": [
{
"name": "TOP",
"value": "5",
"type": "NUMBER"
}
]
}
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "MONTHLY",
"threshold": [
{
"name": "TOP",
"value": "5",
"type": "NUMBER"
}
]
}
]
}
]
}
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 |
2.1 |
|
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Editable Parameters:
| Editable Attributes | Impact | Allowed Values |
|---|---|---|
| isSubscribed | Subscribes or unsubscribes from the Long Tenure Recurring Payments insight. | true, false |
| threshold | The threshold (TOP) can be modified. | Any number between 1 to 100. |
Sample Request:
{
"userSubscription": [
{
"insightName": "LONG_TENURE_RECURRING_PAYMENTS",
"userConfiguration": [
{
"isSubscribed": true,
"entityType": "ACCOUNT",
"threshold": [
{
"name": "TOP",
"type": "NUMBER",
"value": "5"
}
]
}
]
}
]
}
Error Messages:
| HTTP Status Code | Reason |
|---|---|
| 400 | Y806: Invalid input |
| 400 | Y800: Invalid value for insightName |
| 400 | Y800: Invalid value for input param in LONG_TENURE_RECURRING_PAYMENTS insight |
| 400 | Y802: For insight LONG_TENURE_RECURRING_PAYMENTS, modifying frequency is not allowed |
| 400 | Y802: Specifying duration attribute for LONG_TENURE_RECURRING_PAYMENTS insight is not allowed |
| 400 | Y800: Invalid value for TOP in LONG_TENURE_RECURRING_PAYMENTS insight Min =1 and Max = 100 |
| 400 | Y813: Invalid request. The entire object within threshold should be provided |
| 400 | Y802: Modifying insightTitle using this API is not allowed |
| 400 | Y802: For insight LONG_TENURE_RECURRING_PAYMENTS, modifying applicableEntity is not allowed |
| 400 | Y802: For insight LONG_TENURE_RECURRING_PAYMENTS, modifying triggerType is not allowed |
| 400 | Y802: For insight LONG_TENURE_RECURRING_PAYMENTS, modifying container is not allowed |
| 400 | Y802: For insight LONG_TENURE_RECURRING_PAYMENTS, 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 | 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 LONG_TENURE_RECURRING_PAYMENTS insight are - [ACCOUNT] |
| 400 | Y800: Invalid value for threshold data in LONG_TENURE_RECURRING_PAYMENTS insight |
| 400 | Y802: For insight LONG_TENURE_RECURRING_PAYMENTS, configurations at an entityId level are not allowed |
| 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 Long Tenure Recurring Payments insight.
The entityId filter does not apply to 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 |
2.1 |
|
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Sample Request:
GET /insights/feed?insightName=LONG_TENURE_RECURRING_PAYMENTS
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
{
"feed":[
{
"id":"60d43db8d59fdb46b0c911fa",
"insightName":"LONG_TENURE_RECURRING_PAYMENTS",
"insightTitle":"Long Tenure Recurring Payments",
"insightType":"AGGREGATE",
"triggerType":"SCHEDULE",
"createdDate":"2021-06-24T08:09:27Z",
"subscription":[
{
"entityType":"ACCOUNT",
"frequency":"MONTHLY",
"threshold":[
{
"name":"TOP",
"value":"5",
"type":"NUMBER"
}
]
}
],
"basicMerchants":[
{
"name":"Netflix",
"basicPredictedEvents":[
{
"id":11543007,
"link":{
"entityName":"account",
"url":"/predictedEvents/11543007"
},
"category":"Entertainment",
"lastTransactionAmount":{
"amount":300.0,
"currency":"USD"
},
"lastTransactionDate":"2021-06-24",
"frequency":"MONTHLY"
}
]
},
{
"name":"LA Fitness",
"basicPredictedEvents":[
{
"id":11542998,
"link":{
"entityName":"account",
"url":"/predictedEvents/11542998"
},
"category":"Personal Care",
"lastTransactionAmount":{
"amount":300.0,
"currency":"USD"
},
"lastTransactionDate":"2021-06-24",
"frequency":"MONTHLY"
}
]
},
{
"name":"Duke Energy",
"basicPredictedEvents":[
{
"id":11542993,
"link":{
"entityName":"account",
"url":"/predictedEvents/11542993"
},
"category":"Utilities",
"lastTransactionAmount":{
"amount":100.0,
"currency":"USD"
},
"lastTransactionDate":"2021-06-24",
"frequency":"MONTHLY"
}
]
},
{
"name":"LegalZoom",
"basicPredictedEvents":[
{
"id":11542976,
"link":{
"entityName":"account",
"url":"/predictedEvents/11542976"
},
"category":"Online Services",
"lastTransactionAmount":{
"amount":390.0,
"currency":"USD"
},
"lastTransactionDate":"2021-06-24",
"frequency":"MONTHLY"
}
]
},
{
"name":"Comcast",
"basicPredictedEvents":[
{
"id":11543024,
"link":{
"entityName":"account",
"url":"/predictedEvents/11543024"
},
"category":"Cable/Satellite Services",
"lastTransactionAmount":{
"amount":740.0,
"currency":"USD"
},
"lastTransactionDate":"2021-06-24",
"frequency":"MONTHLY"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"feed":[
{
"id":"60d43db8d59fdb46b0c911fa",
"insightName":"LONG_TENURE_RECURRING_PAYMENTS",
"insightTitle":"Long Tenure Recurring Payments",
"insightType":"AGGREGATE",
"triggerType":"SCHEDULE",
"createdDate":"2021-06-24T08:09:27Z",
"subscription":[
{
"entityType":"ACCOUNT",
"frequency":"MONTHLY",
"threshold":[
{
"name":"TOP",
"value":"5",
"type":"NUMBER"
}
]
}
],
"basicMerchant":[
{
"name":"Netflix",
"basicPredictedEvent":[
{
"id":11543007,
"link":{
"entityName":"account",
"url":"/predictedEvents/11543007"
},
"category":"Entertainment",
"lastTransactionAmount":{
"amount":300.0,
"currency":"USD"
},
"lastTransactionDate":"2021-06-24",
"frequency":"MONTHLY"
}
]
},
{
"name":"LA Fitness",
"basicPredictedEvent":[
{
"id":11542998,
"link":{
"entityName":"account",
"url":"/predictedEvents/11542998"
},
"category":"Personal Care",
"lastTransactionAmount":{
"amount":300.0,
"currency":"USD"
},
"lastTransactionDate":"2021-06-24",
"frequency":"MONTHLY"
}
]
},
{
"name":"Duke Energy",
"basicPredictedEvent":[
{
"id":11542993,
"link":{
"entityName":"account",
"url":"/predictedEvents/11542993"
},
"category":"Utilities",
"lastTransactionAmount":{
"amount":100.0,
"currency":"USD"
},
"lastTransactionDate":"2021-06-24",
"frequency":"MONTHLY"
}
]
},
{
"name":"LegalZoom",
"basicPredictedEvent":[
{
"id":11542976,
"link":{
"entityName":"account",
"url":"/predictedEvents/11542976"
},
"category":"Online Services",
"lastTransactionAmount":{
"amount":390.0,
"currency":"USD"
},
"lastTransactionDate":"2021-06-24",
"frequency":"MONTHLY"
}
]
},
{
"name":"Comcast",
"basicPredictedEvent":[
{
"id":11543024,
"link":{
"entityName":"account",
"url":"/predictedEvents/11543024"
},
"category":"Cable/Satellite Services",
"lastTransactionAmount":{
"amount":740.0,
"currency":"USD"
},
"lastTransactionDate":"2021-06-24",
"frequency":"MONTHLY"
}
]
}
]
}
]
}