# FraudContributors

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

The built-in screening rules. Each is configured on its own and each carries its own enabled
flag and action, so enabling one rule does not affect any other.

## Fields
- `velocity` ([VelocityContributorConfig](https://devportal.demo.winkpg.io/docs/api/models/VelocityContributorConfig.md)): Velocity Handler: caps how many transactions, and how much value, a merchant may run in a window.
  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` ([VelocitySettings](https://devportal.demo.winkpg.io/docs/api/models/VelocitySettings.md)): The velocity limits. Null leaves the rule unconfigured, which screens nothing.
- `duplicateTransaction` ([DuplicateTransactionContributorConfig](https://devportal.demo.winkpg.io/docs/api/models/DuplicateTransactionContributorConfig.md)): Duplicate Transaction Manager: flags a repeat of a transaction already seen inside the configured window.
  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` ([DuplicateTransactionSettings](https://devportal.demo.winkpg.io/docs/api/models/DuplicateTransactionSettings.md)): The duplicate-detection settings. Null leaves the rule unconfigured, which screens nothing.
- `amountRange` ([AmountRangeContributorConfig](https://devportal.demo.winkpg.io/docs/api/models/AmountRangeContributorConfig.md)): Amount Range Handler: flags a transaction whose amount falls outside the configured floor and ceiling.
  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` ([AmountRangeSettings](https://devportal.demo.winkpg.io/docs/api/models/AmountRangeSettings.md)): The amount bounds. Null leaves the rule unconfigured, which screens nothing.
- `ipWhitelist` ([IPWhitelistContributorConfig](https://devportal.demo.winkpg.io/docs/api/models/IPWhitelistContributorConfig.md)): Whitelisted IPs: flags a cardholder IP address that matches none of the allowed ranges.
  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` ([IPWhitelistSettings](https://devportal.demo.winkpg.io/docs/api/models/IPWhitelistSettings.md)): The allowed ranges. Null leaves the rule unconfigured, which screens nothing.
- `ipBlacklist` ([IPBlacklistContributorConfig](https://devportal.demo.winkpg.io/docs/api/models/IPBlacklistContributorConfig.md)): Blacklisted IPs: flags a cardholder IP address that matches one of the blocked ranges.
  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` ([IPBlacklistSettings](https://devportal.demo.winkpg.io/docs/api/models/IPBlacklistSettings.md)): The blocked ranges. Null leaves the rule unconfigured, which screens nothing.
- `ipCountryRestriction` ([IPCountryRestrictionContributorConfig](https://devportal.demo.winkpg.io/docs/api/models/IPCountryRestrictionContributorConfig.md)): Country Restrictions Manager: flags a transaction by the country resolved from the cardholder IP address.
  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` ([IPCountryRestrictionSettings](https://devportal.demo.winkpg.io/docs/api/models/IPCountryRestrictionSettings.md)): The country lists. Null leaves the rule unconfigured, which screens nothing.
- `binCountryMismatch` ([BinCountryMismatchContributorConfig](https://devportal.demo.winkpg.io/docs/api/models/BinCountryMismatchContributorConfig.md)): BIN Country Mismatch: flags a transaction whose card issuer country, billing country and  cardholder IP country disagree. Null or absent leaves the rule off.
  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` ([BinCountryMismatchSettings](https://devportal.demo.winkpg.io/docs/api/models/BinCountryMismatchSettings.md)): The comparisons to run. Null leaves the rule unconfigured, which screens nothing.
- `timeOfDayRestriction` ([TimeOfDayRestrictionContributorConfig](https://devportal.demo.winkpg.io/docs/api/models/TimeOfDayRestrictionContributorConfig.md)): Time of Day Restriction: flags a transaction created outside the merchant's allowed hours.  Null or absent leaves the rule off.
  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.

## See also

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