velocity
required |
VelocityContributorConfig
VelocityContributorConfig |
Velocity Handler: caps how many transactions, and how much value, a merchant may run in a window.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of VelocityContributorConfig:
| Field |
Type |
Description |
|---|
enabled
required |
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.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| actionWhenTriggered
required |
ActionWhenTriggeredType
ActionWhenTriggeredType |
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:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
AuditOnly |
| Stop |
| HoldForReview |
|
| settings
required |
VelocitySettings
VelocitySettings |
The velocity limits. Null leaves the rule unconfigured, which screens nothing.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
duplicateTransaction
required |
DuplicateTransactionContributorConfig
DuplicateTransactionContributorConfig |
Duplicate Transaction Manager: flags a repeat of a transaction already seen inside the configured window.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of DuplicateTransactionContributorConfig:
| Field |
Type |
Description |
|---|
enabled
required |
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.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| actionWhenTriggered
required |
ActionWhenTriggeredType
ActionWhenTriggeredType |
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:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
AuditOnly |
| Stop |
| HoldForReview |
|
| settings
required |
DuplicateTransactionSettings
DuplicateTransactionSettings |
The duplicate-detection settings. Null leaves the rule unconfigured, which screens nothing.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
amountRange
required |
AmountRangeContributorConfig
AmountRangeContributorConfig |
Amount Range Handler: flags a transaction whose amount falls outside the configured floor and ceiling.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of AmountRangeContributorConfig:
| Field |
Type |
Description |
|---|
enabled
required |
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.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| actionWhenTriggered
required |
ActionWhenTriggeredType
ActionWhenTriggeredType |
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:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
AuditOnly |
| Stop |
| HoldForReview |
|
| settings
required |
AmountRangeSettings
AmountRangeSettings |
The amount bounds. Null leaves the rule unconfigured, which screens nothing.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
ipWhitelist
required |
IPWhitelistContributorConfig
IPWhitelistContributorConfig |
Whitelisted IPs: flags a cardholder IP address that matches none of the allowed ranges.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of IPWhitelistContributorConfig:
| Field |
Type |
Description |
|---|
enabled
required |
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.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| actionWhenTriggered
required |
ActionWhenTriggeredType
ActionWhenTriggeredType |
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:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
AuditOnly |
| Stop |
| HoldForReview |
|
| settings
required |
IPWhitelistSettings
IPWhitelistSettings |
The allowed ranges. Null leaves the rule unconfigured, which screens nothing.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
ipBlacklist
required |
IPBlacklistContributorConfig
IPBlacklistContributorConfig |
Blacklisted IPs: flags a cardholder IP address that matches one of the blocked ranges.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of IPBlacklistContributorConfig:
| Field |
Type |
Description |
|---|
enabled
required |
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.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| actionWhenTriggered
required |
ActionWhenTriggeredType
ActionWhenTriggeredType |
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:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
AuditOnly |
| Stop |
| HoldForReview |
|
| settings
required |
IPBlacklistSettings
IPBlacklistSettings |
The blocked ranges. Null leaves the rule unconfigured, which screens nothing.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
ipCountryRestriction
required |
IPCountryRestrictionContributorConfig
IPCountryRestrictionContributorConfig |
Country Restrictions Manager: flags a transaction by the country resolved from the cardholder IP address.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of IPCountryRestrictionContributorConfig:
| Field |
Type |
Description |
|---|
enabled
required |
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.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| actionWhenTriggered
required |
ActionWhenTriggeredType
ActionWhenTriggeredType |
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:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
AuditOnly |
| Stop |
| HoldForReview |
|
| settings
required |
IPCountryRestrictionSettings
IPCountryRestrictionSettings |
The country lists. Null leaves the rule unconfigured, which screens nothing.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
binCountryMismatch
required |
BinCountryMismatchContributorConfig
BinCountryMismatchContributorConfig |
BIN Country Mismatch: flags a transaction whose card issuer country, billing country and
cardholder IP country disagree. Null or absent leaves the rule off.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of BinCountryMismatchContributorConfig:
| Field |
Type |
Description |
|---|
enabled
required |
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.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| actionWhenTriggered
required |
ActionWhenTriggeredType
ActionWhenTriggeredType |
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:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
AuditOnly |
| Stop |
| HoldForReview |
|
| settings
required |
BinCountryMismatchSettings
BinCountryMismatchSettings |
The comparisons to run. Null leaves the rule unconfigured, which screens nothing.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
timeOfDayRestriction
required |
TimeOfDayRestrictionContributorConfig
TimeOfDayRestrictionContributorConfig |
Time of Day Restriction: flags a transaction created outside the merchant's allowed hours.
Null or absent leaves the rule off.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of TimeOfDayRestrictionContributorConfig:
| Field |
Type |
Description |
|---|
enabled
required |
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.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| actionWhenTriggered
required |
ActionWhenTriggeredType
ActionWhenTriggeredType |
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:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
AuditOnly |
| Stop |
| HoldForReview |
|
| settings
required |
TimeOfDayRestrictionSettings
TimeOfDayRestrictionSettings |
The allowed window. Null leaves the rule unconfigured, which screens nothing.
Required: When Enabled is true.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |