Refund Deposited
Overview
The Refund Deposited insight is a refresh-triggered insight that alerts users when a refund above a user-specified threshold was deposited to an aggregated bank or card account.
Note: The insight is generated only for the transactions that are categorized by the system in Expense Reimbursement or Refunds/Adjustments category.
Following are the additional details for the insight:
| Insight Name | REFUND_DEPOSITED |
|---|---|
| Applicable Entities | ACCOUNT, VIEW |
| Insight Type | OTHER |
| Trigger Type | REFRESH |
| Supported Containers | BANK, CARD |
Use Cases
- Customer:
- User engagement
- User:
- Track pending refunds: Enable users to track pending refunds since the duration of refunds varies from merchant to merchant.
Suggested Action
Suggest the user to review the refund and make sure that the refund amount is as expected.
Duplicate Insight Checks
To prevent the same insight from generating repeatedly, the insight is generated once in last 30 days for each account 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 the user decide when the user has to be alerted about a refund transaction. If the transaction amount is above the MINIMUM threshold, an insight is generated for the user.
- Threshold Name: MINIMUM
- Data Type: AMOUNT
- Range Allowed: 1.00 <= CHANGE <= 1000000.00
- Default: 1.00
Note: Only USD currency is currently supported. 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 |
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": "REFUND_DEPOSITED",
"insightTitle": "Refund Deposited",
"insightType": "OTHER",
"triggerType": "REFRESH",
"containers": [
"BANK",
"CARD"
],
"description": "Generates an insight when a refund is posted that is more than a configured threshold.",
"applicableEntity": [
"ACCOUNT",
"VIEW"
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
},
{
"entityType": "VIEW",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"customerSubscription":[
{
"insightName": "REFUND_DEPOSITED",
"insightTitle": "Refund Deposited",
"insightType": "OTHER",
"triggerType": "REFRESH",
"container": [
"BANK",
"CARD"
],
"description": "Generates an insight when a refund is posted that is more than a configured threshold.",
"applicableEntity": [
"ACCOUNT",
"VIEW"
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
},
{
"entityType": "VIEW",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
}
]
}
]
}
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 Refund Deposited 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 (MINIMUM) for generating the Refund Deposited insight can be changed. | Any number between 1.00 to 1000000.00. |
Sample Request:
{
"customerSubscription":[
{
"insightName": "REFUND_DEPOSITED",
"insightTitle": "Refund Deposited",
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
},
{
"entityType": "VIEW",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
}
]
}
]
}
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 MINIMUM in REFUND_DEPOSITED insight Min = 1.00 and Max =1000000.00 |
| 400 | Y813: Invalid request. The entire object within threshold should be provided |
| 400 | Y802: For insight REFUND_DEPOSITED, modifying applicableEntity is not allowed |
| 400 | Y802: For insight REFUND_DEPOSITED, modifying triggerType is not allowed |
| 400 | Y802: For insight REFUND_DEPOSITED, modifying container is not allowed |
| 400 | Y802: For insight REFUND_DEPOSITED, 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 REFUND_DEPOSITED insight is not allowed |
| 400 | Y802: Specifying duration attribute for REFUND_DEPOSITED 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 REFUND_DEPOSITED insight are - [ACCOUNT, VIEW] |
| 400 | Y802: For REFUND_DEPOSITED insight, {Invalid String} inside the threshold is either repeated or not allowed |
| 400 | Y802: For REFUND_DEPOSITED 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 |
2.1 |
|
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Sample Request:
GET /insights/configs/userSubscriptions?insightName=REFUND_DEPOSITED
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": "REFUND_DEPOSITED",
"insightTitle": "Refund Deposited",
"insightType": "OTHER",
"triggerType": "REFRESH",
"containers": [
"BANK",
"CARD"
],
"description": "Generates an insight when a refund is posted that is more than a configured threshold.",
"applicableEntity": [
"ACCOUNT",
"VIEW"
],
"userConfiguration": [
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
},
{
"entityType": "VIEW",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
}
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
},
{
"entityType": "VIEW",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"userSubscription":[
{
"insightName": "REFUND_DEPOSITED",
"insightTitle": "Refund Deposited",
"insightType": "OTHER",
"triggerType": "REFRESH",
"containers": [
"BANK",
"CARD"
],
"description": "Generates an insight when a refund is posted that is more than a configured threshold.",
"applicableEntity": [
"ACCOUNT",
"VIEW"
],
"userConfiguration": [
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
},
{
"entityType": "VIEW",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
}
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
},
{
"entityType": "VIEW",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
}
]
}
]
}
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.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 insight gets evaluated. | Valid IDs for accounts or views belonging to the user. |
| isSubscribed | Subscribes or unsubscribes from the Refund Deposited insight. | true, false |
| threshold | The threshold value (MINIMUM) for generating the Refund Deposited insight can be changed. | Any number between 1.00 to 1000000.00. |
Sample Request:
{
"userSubscription":[
{
"insightName":"REFUND_DEPOSITED",
"userConfiguration": [
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
},
{
"entityType": "VIEW",
"isSubscribed": true,
"threshold": [
{
"name": "MINIMUM",
"value": "1",
"type": "AMOUNT"
}
]
}
]
}
]
}
Error Messages:
| HTTP Status Code | Reason |
|---|---|
| 400 | Y806: Invalid input |
| 400 | Y800: Invalid value for insightName |
| 400 | Y800: Invalid value for input param in REFUND_DEPOSITED insight |
| 400 | Y800: Invalid value for threshold data in REFUND_DEPOSITED insight |
| 400 | Y800: Invalid value for MINIMUM in REFUND_DEPOSITED insight Min = 1.00 and Max =1000000.00 |
| 400 | Y800: Invalid 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 REFUND_DEPOSITED, modifying applicableEntity is not allowed |
| 400 | Y802: For insight REFUND_DEPOSITED, modifying triggerType is not allowed |
| 400 | Y802: For insight REFUND_DEPOSITED, modifying container is not allowed |
| 400 | Y802: For insight REFUND_DEPOSITED, modifying description is not allowed |
| 400 | Y802: Duplicate entityId entries within userConfiguration is not allowed |
| 400 | Y802: Specifying frequency attribute for REFUND_DEPOSITED insight is not allowed |
| 400 | Y802: Specifying duration attribute for REFUND_DEPOSITED 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 REFUND_DEPOSITED 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 Refund Deposited 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=REFUND_DEPOSITED
Sample Response:
For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.
{
"feed":[
{
"id":"60d43d99d59fdb46b0c91103",
"insightName":"REFUND_DEPOSITED",
"insightTitle":"Refund Deposited",
"insightType":"OTHER",
"triggerType":"REFRESH",
"createdDate":"2021-06-24T08:08:53Z",
"subscription":[
{
"entityId":"60d43ca2f74fce189c9cf1b9",
"entityType":"VIEW",
"threshold":[
{
"name":"MINIMUM",
"value":"1",
"type":"AMOUNT"
}
]
}
],
"basicView":[
{
"id":"60d43ca2f74fce189c9cf1b9",
"name":"View 1",
"link":{
"entityName":"view",
"url":"/views/60d43ca2f74fce189c9cf1b9"
},
"basicAccount":[
{
"id":13709572,
"providerName":"Dag Site",
"accountName":"PDV Test Data- All Category",
"accountType":"OTHER",
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=13709572"
},
"basicTransaction":[
{
"id":47306984,
"amount":{
"amount":1308.75,
"currency":"USD"
},
"date":"2021-06-21",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=47306984"
},
"categoryId":227,
"category":"Refunds/Adjustments",
"categoryType":"INCOME",
"baseType":"CREDIT",
"description":{
"original":"Returned Item Credit Effective Date: 11/10/201X",
"simple":"Returned Item Credit"
},
"sourceType":"AGGREGATED",
"merchantType":"OTHERS"
}
]
}
]
}
]
}
]
}