Card Statement Available
Overview
The Card Statement Available insight is a refresh-triggered insight that reminds users when their credit card statement is available. The insight will be triggered on a successful refresh of a card account when a new statement is found.
The insight for VIEW is generated only if the VIEW rule contains valid card accounts.
Following are the additional details for the insight:
| Insight Name | CARD_STATEMENT_AVAILABLE |
|---|---|
| Applicable Entities | ACCOUNT, VIEW |
| Insight Type | OTHER |
| Trigger Type | REFRESH |
| Supported Container | CARD |
Use Cases
- Customer:
- User engagement
- User:
- Financial discipline - Pay credit card bills on time and avoid late fees.
Suggested Action
Suggest the user to pay the bill by due date.
Duplicate Insight Checks
To prevent the same insight from generating repeatedly, the insight is generated once every 32 days (including the date of insight evaluation) for each statement ID per entity ID.
Insight Dynamic Trigger (On-Demand Evaluation)
The dynamic trigger is applicable to the insight. Depending on the configuration, this insight can be invoked dynamically when:
- A new View is created
OR - A View ID is patched using the user subscription API
The insight is generated dynamically using any of the above two methods only if the view is eligible and the other insight generation checks are passed.
Note: By default, the configuration is set to dynamically trigger insight evaluation every time a new entityId (view ID) is added using the PATCH userSubscription API. During onboarding, this preference can be changed.
Peer Benchmarking Data
This insight does not provide peer benchmarking data.
Thresholds
Threshold lets the customer or user decide when the insight has to be generated. By default the insight will be generated as soon as a new statement is available and if the account is refreshed successfully.
- Threshold Name: DAYS_BEFORE
- Data Type: DAYS
- Range Allowed: 0 <= Number of Days <= 31
- Default: 10
Note: Depending on the customer segment and account, the 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.
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":"CARD_STATEMENT_AVAILABLE",
"insightTitle":"Card Statement Available",
"insightType":"OTHER",
"triggerType":"REFRESH",
"containers":[
"CARD"
],
"description":"Generates an insight when a new credit card statement is available.",
"applicableEntity":[
"ACCOUNT",
"VIEW"
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"customerSubscription":[
{
"insightName":"CARD_STATEMENT_AVAILABLE",
"insightTitle":"Card Statement Available",
"insightType":"OTHER",
"triggerType":"REFRESH",
"container":[
"CARD"
],
"description":"Generates an insight when a new credit card statement is available.",
"applicableEntity":[
"ACCOUNT",
"VIEW"
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
}
]
}
]
}
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 Card Statement Available 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) |
| threshold | The threshold value (DAYS_BEFORE) for generating the Card Statement Available insight can be changed. Spcifying the threshold determines the days until which the insight can be generated. | Any number between 0 to 31 |
Sample Request:
{
"customerSubscription":[
{
"insightName":"CARD_STATEMENT_AVAILABLE",
"insightTitle":"New Title",
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
}
]
}
]
}
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 DAYS_BEFORE in CARD_STATEMENT_AVAILABLE insight Min = 0 and Max = 31 |
| 400 | Y813: Invalid request. The entire object within threshold should be provided |
| 400 | Y802: For insight CARD_STATEMENT_AVAILABLE, modifying applicableEntity is not allowed |
| 400 | Y802: For insight CARD_STATEMENT_AVAILABLE, modifying triggerType is not allowed |
| 400 | Y802: For insight CARD_STATEMENT_AVAILABLE, modifying container is not allowed |
| 400 | Y802: For insight CARD_STATEMENT_AVAILABLE, 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 CARD_STATEMENT_AVAILABLE insight is not allowed |
| 400 | Y802: Specifying duration attribute for CARD_STATEMENT_AVAILABLE insight 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 CARD_STATEMENT_AVAILABLE insight are - [ACCOUNT, VIEW] |
| 400 | Y802: For CARD_STATEMENT_AVAILABLE insight, {Invalid String} inside the threshold is either repeated or not allowed |
| 400 | Y802: For CARD_STATEMENT_AVAILABLE 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.
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=CARD_STATEMENT_AVAILABLE
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":"CARD_STATEMENT_AVAILABLE",
"insightTitle":"Card Statement Available",
"insightType":"OTHER",
"triggerType":"REFRESH",
"containers":[
"CARD"
],
"description":"Generates an insight when a new credit card statement is available.",
"applicableEntity":[
"ACCOUNT",
"VIEW"
],
"userConfiguration":[
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
}
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"userSubscription":[
{
"insightName":"CARD_STATEMENT_AVAILABLE",
"insightTitle":"Card Statement Available",
"insightType":"OTHER",
"triggerType":"REFRESH",
"container":[
"CARD"
],
"description":"Generates an insight when a new credit card statement is available.",
"applicableEntity":[
"ACCOUNT",
"VIEW"
],
"userConfiguration":[
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
}
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
}
]
}
]
}
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 |
3.0 |
|
2.1 |
||
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Editable Parameters:
| Editable Attributes | Impact | Allowed Values |
|---|---|---|
| entityId | The ID of the account or view for which card statement gets evaluated. | Valid IDs for accounts or views belonging to the user. |
| isSubscribed | Subscribes or unsubscribes from the Card Statement Available insight. | true, false |
| threshold | The threshold value (DAYS_BEFORE) for generating the Card Statement Available insight can be changed. Spcifying the threshold determines the days until which the insight can be generated. | Any number between 0 to 31 |
Sample Request:
{
"userSubscription":[
{
"insightName":"CARD_STATEMENT_AVAILABLE",
"userConfiguration":[
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"10",
"type":"DAYS"
}
]
}
]
}
]
}
Error Messages:
| HTTP Status Code | Reason |
|---|---|
| 400 | Y806: Invalid input |
| 400 | Y800: Invalid value for insightName |
| 400 | Y800: Invalid value for input param in CARD_STATEMENT_AVAILABLE insight |
| 400 | Y800: Invalid value for threshold data in CARD_STATEMENT_AVAILABLE insight |
| 400 | Y800: Invalid value for DAYS_BEFORE in CARD_STATEMENT_AVAILABLE insight Min = 0 and Max = 31 |
| 400 | Y800: IInvalid value for entityId; This id is either invalid or not supported for this insight. |
| 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 CARD_STATEMENT_AVAILABLE, modifying applicableEntity is not allowed |
| 400 | Y802: For insight CARD_STATEMENT_AVAILABLE, modifying triggerType is not allowed |
| 400 | Y802: For insight CARD_STATEMENT_AVAILABLE, modifying container is not allowed |
| 400 | Y802: For insight CARD_STATEMENT_AVAILABLE, modifying description is not allowed |
| 400 | Y802: Duplicate entityId entries within userConfiguration is not allowed |
| 400 | Y802: Specifying frequency attribute for CARD_STATEMENT_AVAILABLE insight is not allowed |
| 400 | Y802: Specifying duration attribute for CARD_STATEMENT_AVAILABLE 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 | 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 CARD_STATEMENT_AVAILABLE 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, the Card Statement Available insight can be specifically requested.
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=CARD_STATEMENT_AVAILABLE
Sample Response:
For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.
{
"feed":[
{
"id":"60dae2a12c672e4118e93281",
"insightName":"CARD_STATEMENT_AVAILABLE",
"insightTitle":"Card Statement Available",
"insightType":"OTHER",
"triggerType":"REFRESH",
"createdDate":"2021-06-29T09:06:41Z",
"subscription":[
{
"entityId":"13722479",
"entityType":"ACCOUNT",
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"0",
"type":"DAYS"
}
]
}
],
"cardAccount":[
{
"id":13722479,
"providerName":"Dag Site",
"accountName":"Super CD Plus CSA1 CurrentDate",
"accountType":"CREDIT",
"container":"creditCard",
"link":{
"entityName":"account",
"methodType":"GET",
"url":"/accounts?accountId=13722479"
},
"totalCreditLine":{
"amount":100.0,
"currency":"USD"
},
"balance":{
"amount":756.88,
"currency":"USD"
},
"basicStatement":[
{
"id":11590131,
"accountId":13722479,
"statementDate":"2021-06-29",
"dueDate":"2021-06-29",
"billingPeriodStart":"2018-01-21",
"amountDue":{
"amount":9900.0,
"currency":"USD"
},
"minPaymentDue":{
"amount":200.0,
"currency":"USD"
},
"link":{
"entityName":"statement",
"url":"/statements?accountId=13722479"
}
}
]
}
]
},
{
"id":"60dafb282c672e4118e940f7",
"insightName":"CARD_STATEMENT_AVAILABLE",
"insightTitle":"Card Statement Available",
"insightType":"OTHER",
"triggerType":"REFRESH",
"createdDate":"2021-06-29T10:51:18Z",
"subscription":[
{
"entityId":"60daf6fd2147c340f132a180",
"entityType":"VIEW",
"threshold":[
{
"name":"DAYS_BEFORE",
"value":"0",
"type":"DAYS"
}
]
}
],
"basicView":[
{
"id":"60daf6fd2147c340f132a180",
"name":"View",
"link":{
"entityName":"view",
"url":"/views/60daf6fd2147c340f132a180"
},
"cardAccount":[
{
"id":13722536,
"providerName":"Dag Site",
"accountName":"Card Statement Available 30dAAys",
"accountType":"CREDIT",
"container":"creditCard",
"link":{
"entityName":"account",
"methodType":"GET",
"url":"/accounts?accountId=13722536"
},
"totalCreditLine":{
"amount":100000.0,
"currency":"USD"
},
"balance":{
"amount":22000.0,
"currency":"USD"
},
"basicStatement":[
{
"id":11590139,
"accountId":13722536,
"statementDate":"2021-06-29",
"dueDate":"2021-06-28",
"billingPeriodStart":"2020-02-01",
"billingPeriodEnd":"2020-02-29",
"amountDue":{
"amount":7777.0,
"currency":"USD"
},
"minPaymentDue":{
"amount":121.0,
"currency":"USD"
},
"link":{
"entityName":"statement",
"url":"/statements?accountId=13722536"
}
}
]
}
]
}
]
}
]
}