Class AddRiskProfileRequest
Request to add a new Risk profile
Properties
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| RequestId | System.string | Unique identifier used to identify the request. Used when associating the request to the response. |
| RequestDate | System.DateTime | DateTime request was made. Request timeout is 1 minute. |
| Credentials | StoreCredentials | |
| DailyAmountLimit | System.Decimal | Only Required if TemplateName is not supplied. Decimal field max value is 999999999. Value must be less than or equal to PeriodAmountLimit. Limit of total amount per day. |
| DailyCountLimit | System.Int32 | Decimal field max value is 999999999. Value must be less than or equal to PeriodCountLimit. Limit of checks per day. Required field. |
| Description | System.String | String value with a max length of 250 characters. A brief description of the template. Required field. Limit of total amount per period. Required field. |
| IsEnabled | System.Boolean | A Boolean value that indicates if the account is enabled or disabled. |
| MinimumAmountThreshold | System.Nullable<System.Decimal> | This field represents the "Minimum Amount Threshold" risk setting. Valid values are $1.00 to $99,999,999.99. RDA deposited items that are below the minimum amount threshold will not be evaluated by any risk settings. |
| PeriodAmountLimit | System.Decimal | Only Required if TemplateName is not supplied. Decimal field max value is 999999999. Value must be greater than or equal to DailyAmountLimit. Limit of checks per period. |
| PeriodCountLimit | System.Int32 | Only Required if TemplateName is not supplied. Decimal field max value is 999999999. Value must be greater than or equal to DailyCountLimit. |
| ProfileName | System.String | Name given to identify the Risk Profile in the EPS system. Maximum length is 50 characters. Profile Name must be unique. |
| RiskAction1 | RiskAction | Valid Risk Actions are Disabled, Approve, Suspend. Action that can be taken for Risk Setting 1 - Minimum number of days since enrollment |
| RiskAction2 | RiskAction | Valid Risk Actions are Disabled, Approve, Suspend. Action that can be taken for Risk Setting 2 - Minimum number of deposits since enrollment |
| RiskAction3 | RiskAction | Valid Risk Actions are Disabled, Approve, Suspend. Action that can be taken for Risk Setting 3 - Zero successful deposits within the last number of days |
| RiskAction4 | RiskAction | Valid Risk Actions are Disabled, Approve, Suspend. Action that can be taken for Risk Setting 4 - Rejected deposits within the last number of days |
| RiskAction5 | RiskAction | Valid Risk Actions are Disabled, Approve, Suspend. Action that can be taken for Risk Setting 5 - MICR Denylist violations within the last number of days |
| RiskAction6 | RiskAction | Valid Risk Actions are Disabled, Approve, Suspend. Action that can be taken for Risk Setting 6 - Twice the User's Average Deposit and Above Amount |
| RiskAction7 | RiskAction | Valid Risk Actions are Disabled, Approve, Suspend. Action that can be taken for Risk Setting 7 - Outside Normal Deposit Hours |
| RiskAction8 | System.Boolean | Valid Risk Actions are Disabled and Enabled. Action that can be taken for Risk Setting 8 - Restrictive Endorsement Confidence Levels |
| RiskSetting1 | System.Nullable<System.Int32> | Risk Setting 1 = Minimum number of days since enrollment. Max value is 90. Valid values are based on 1 - 90 days (calendar days). Risk Setting 1 will allow the ability to take action on all RDA deposits made in the first few days, weeks or months after a user's initial enrollment. |
| RiskSetting2 | System.Nullable<System.Int32> | Risk Setting 2 = Minimum number of deposits since enrollment. Max value is 10. Valid values are based on 1 - 10 deposits. Risk Setting 2 will allow the ability to take action on a set number of successful RDA deposits after a user's initial enrollment. |
| RiskSetting3 | System.Nullable<System.Int32> | Risk Setting 3 = Zero successful deposits within the last number of days. Max value is 180. Valid values are based on 1 - 180 days (calendar days). Risk Setting 3 will allow the ability to take action on a user's first deposit after the user has been dormant for a specified period of time |
| RiskSetting4 | System.Nullable<System.Int32> | Risk Setting 4 = Rejected deposits within the last number of days. Max value is 180. Valid values are based on 1 - 180 days (calendar days). Risk Setting 4 will allow the ability to take action on future RDA deposits (for a set number of days) after a user has a RDA deposit declined. |
| RiskSetting5 | System.Nullable<System.Int32> | Risk Setting 5 = MICR Denylist violations within the last number of days. Max value is 180. Valid values are based on 1 - 180 days (calendar days). Risk Setting 5 will allow the ability to take action on future RDA deposits (for a set number of days) after a MICR Denylist violation. |
| RiskSetting6 | System.Nullable<System.Decimal> | Risk Setting 6 = Twice the User's Average Deposit and Above Amount. This field represents the "Above Amount" risk setting. Maximum value is $100,000.00. Valid values are $0.00 to $100,000.00. Risk Setting 6 will allow the ability to approve or suspend a deposit submitted by a user that is twice their average deposit in the past 90 days and is above $X.XX dollars combined. |
| RiskSetting7Begin | System.String | Risk Setting 7 = Outside Normal Hours. This field represents the "Begin" time for the "Normal Deposit Hours" risk profile setting. Valid values are HH:MM AM or PM. The "Normal Deposit Hours" timeframe is based on the Central time zone. Risk Setting 7 will allow the ability to approve or suspend a deposit that is received outside normal deposit hours. |
| RiskSetting7End | System.String | Risk Setting 7 = Outside Normal Hours. This field represents the "End" time for the "Normal Deposit Hours" risk profile setting. Valid values are HH:MM AM or PM. The "Normal Deposit Hours" timeframe is based on the Central time zone. Risk Setting 7 will allow the ability to approve or suspend a deposit that is received outside normal deposit hours. |
| RiskSetting8High | System.Nullable<System.Int32> | Risk Setting 8 = Restrictive Endorsement Confidence Levels. This field represents the "Restrictive Endorsement" risk setting. Valid values are from 0% - 100%. A deposit with a restrictive endorsement confidence value between the "Mid" and "High" settings will be "Approved" and display in the portal for FI review. A deposit with a restrictive endorsement confidence value above the "High" setting will be "Approved" up-front and will not be displayed in the portal. |
| RiskSetting8Low | System.Nullable<System.Int32> | Risk Setting 8 = Restrictive Endorsement Confidence Levels. This field represents the "Restrictive Endorsement" risk setting. Valid values are from 0% - 100%. A deposit with a restrictive endorsement confidence value below the "Low" setting will be "Declined" up-front and rejected back to the depositor. It will not be displayed in the portal. |
| RiskSetting8Mid | System.Nullable<System.Int32> | Risk Setting 8 = Restrictive Endorsement Confidence Levels. This field represents the "Restrictive Endorsement" risk setting. Valid values are from 0% - 100%. A deposit with a restrictive endorsement confidence value between the "Low" and "Mid" settings will be treated as an exception with a "Suspend" action and will be displayed in the portal for FI review. |
| SingleAmountLimit | System.Decimal | Limit of total amount per item |
| VelocityAction | TemplateAction | Decline, Suspend, Approve |
Example
{
"Credentials":{
"EntityId": "123456",
"StoreId": null,
"StoreKey": null
},
"__type":"AddRiskProfileRequest:#JackHenry.Eps.Mobile.RDAAdmin",
"ProfileName":"String Content",
"Description":"String Content",
"IsEnabled":true,
"SingleAmountLimit":12678967.54,
"DailyCountLimit":0,
"DailyAmountLimit":12678967.54,
"PeriodCountLimit":0,
"PeriodAmountLimit":12678967.54,
"VelocityAction":
"RiskSetting1":
"RiskAction1":
"RiskSetting2":
"RiskAction2":
"RiskSetting3":
"RiskAction3":
"RiskSetting4":
"RiskAction4":
"RiskSetting5":
"RiskAction5":
"RiskSetting6":
"RiskAction6":
"RiskSetting7Begin":"String Content",
"RiskSetting7End":"String Content",
"RiskAction7":
"RiskAction8":true,
"RiskSetting8High":
"RiskSetting8Low":
"RiskSetting8Mid":
"MinimumAmountThreshold":
}
Methods
ToConsumerVelocityTemplate()
Declaration
public ConsumerVelocityTemplate ToConsumerVelocityTemplate()
Returns
| TYPE | DESCRIPTION |
|---|---|
| JHA.EPS.SharedService.Common.Model.BillPay.ConsumerVelocityTemplate |
Validate(IValidatorContext)
Declaration
public override void Validate(IValidatorContext context)
Parameters
| TYPE | NAME | DESCRIPTION |
|---|---|---|
| JHA.EPS.SharedService.Common.Validator.IValidatorContext | context |
Overrides
AuthenticatedRequest.Validate(IValidatorContext)
Exceptions
| TYPE | DESCRIPTION |
|---|---|
| JHA.EPS.SharedService.Common.Validator.ValidationResult | ProfileName cannot be null or empty |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | ProfileName must be beween 1 - 50 characters |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | ProfileName must contain visible characters |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | If Description is not null then Description must be less than 251 characters |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | If Description is not null then Description must be visible characters |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | SingleAmountLimit cannot be greater than DailyAmountLimit |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | DailyCountLimit cannot be greater than PeriodCountLimit |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | DailyAmountLimit cannot be greater than PeriodAmountLimit |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | Must have edit velocity permission |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | ProfileName must exist in our system |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting1 is required when RiskAction1 is not disabled |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting1 must be within range 1 - 90 |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting2 is required when RiskAction2 is not disabled |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting2 must be within range 1 - 10 |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting3 is required when RiskAction3 is not disabled |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting3 must be within range 1 - 180 |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting4 is required when RiskAction4 is not disabled |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting4 must be within range 1 - 180 |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting5 is required when RiskAction5 is not disabled |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting5 must be within range 1 - 180 |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting6 is required when RiskAction6 is not disabled |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting6 must be within range 0 - 100000 |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting7Begin is required when RiskAction7 is not disabled |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting7Begin Time is only considered |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting7End is required when RiskAction7 is not disabled |
| JHA.EPS.SharedService.Common.Validator.ValidationResult | RiskSetting7End Time is only considered |