AmountRangeContributorConfig
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Amount Range Handler configuration: the transaction amount floor and ceiling this merchant screens against.
Values
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
| 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.
| ||||||
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.
| ||||||
Fields of AmountRangeSettings: This body has no documented fields. | ||||||||
This model has no documented fields.