# TimeOfDayRestrictionContributorConfig

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Time of Day Restriction configuration: the hours, and optionally the days, during which this
merchant expects transactions.

## Fields
- `enabled` (boolean): Whether this rule runs. False, the default, means the rule is skipped and never flags a  transaction. A rule that is enabled but has no usable settings also screens nothing.
- `actionWhenTriggered` ([ActionWhenTriggeredType](https://devportal.demo.winkpg.io/docs/api/models/ActionWhenTriggeredType.md)): What happens when this rule flags a transaction. `AuditOnly`, the default, records the  detection and lets the transaction continue. `Stop` halts the transaction before  authorization, and the caller receives HTTP 403 with the error code  `SCREENING_STOPPED`. `HoldForReview` parks the transaction on the fraud review  queue until a reviewer approves or declines it, or the merchant's hold deadline passes.  Whatever the action, the verdict is recorded on the transaction.
  Values:
  - `AuditOnly`
  - `Stop`
  - `HoldForReview`
- `settings` ([TimeOfDayRestrictionSettings](https://devportal.demo.winkpg.io/docs/api/models/TimeOfDayRestrictionSettings.md)): The allowed window. Null leaves the rule unconfigured, which screens nothing. Required: When Enabled is true.
  Fields:
  - `allowedStartMinute` (integer(int32)): Start of the allowed window, in minutes after midnight in `timeZoneId`; the  start minute is inside the window. For example 480 is 8:00. Accepted range 0 to 1439.  Required, with `allowedEndMinute` and `timeZoneId`, when the rule is  enabled. (nullable, min 0, max 1439)
  - `allowedEndMinute` (integer(int32)): End of the allowed window, in minutes after midnight in `timeZoneId`; the end  minute is outside the window. An end earlier than the start describes a window that crosses  midnight, so a start of 1320 and an end of 360 allows 22:00 to 6:00. Accepted range 0 to  1439, and must differ from `allowedStartMinute`. (nullable, min 0, max 1439)
  - `allowedDaysOfWeek` (string): Comma-separated English day names the window applies on, for example  `Monday,Tuesday,Wednesday,Thursday,Friday`. A transaction created on any other day is  flagged. The day is the day on which the window starts, so a window crossing midnight that  starts on Friday covers the early hours of Saturday. Null or blank allows every day. (nullable)
  - `timeZoneId` (string): The IANA time zone the window is expressed in, for example `America/Chicago`. Required  when the rule is enabled. Daylight saving time is applied automatically. (nullable)

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.
