| Name | Type | Description | Notes |
|---|---|---|---|
| affiliate_oid_or_email | String | Affiliate oid (integer) or affiliate email. Email is resolved to oid before searching. | [optional] |
| amount_threshold_begin | Number | Lower bound on amount/score/percentage thresholds (rules backed by the same numeric column). | [optional] |
| amount_threshold_end | Number | Upper bound on amount/score/percentage thresholds (rules backed by the same numeric column). | [optional] |
| auto_note | String | Wildcard search on the rule's auto_note. Use '*' for wildcards. | [optional] |
| count_threshold_begin | Number | Lower bound on count thresholds (rules backed by the same integer count column). | [optional] |
| count_threshold_end | Number | Upper bound on count thresholds (rules backed by the same integer count column). | [optional] |
| created_by | String | Filter to rules created by this user login. | [optional] |
| created_date_begin | String | Rule creation date begin (MM/dd/yyyy) | [optional] |
| created_date_end | String | Rule creation date end (MM/dd/yyyy) | [optional] |
| credit_card_partial | String | Partial credit card number for matching 'credit card matches' rules. Use '*' wildcards. | [optional] |
| decline_message | String | Wildcard search on the rule's decline_message. Use '*' for wildcards. | [optional] |
| failure_action | String | [optional] | |
| gateway_code | String | Filter to rules with this rotating transaction gateway code in their rotating_transaction_gateway_filters list. | [optional] |
| merchant_item_id | String | Filter to rules with this merchant item id in their item_filters list. | [optional] |
| modifier_value | String | Wildcard search on the rule's secondary modifier (eg 'address'/'subnet', gateway codes, avs match types). | [optional] |
| modify_custom_field1 | String | Wildcard search on rules' modify_custom_field1 value. | [optional] |
| modify_custom_field2 | String | Wildcard search on rules' modify_custom_field2 value. | [optional] |
| modify_custom_field3 | String | Wildcard search on rules' modify_custom_field3 value. | [optional] |
| modify_custom_field4 | String | Wildcard search on rules' modify_custom_field4 value. | [optional] |
| modify_custom_field5 | String | Wildcard search on rules' modify_custom_field5 value. | [optional] |
| modify_custom_field6 | String | Wildcard search on rules' modify_custom_field6 value. | [optional] |
| modify_custom_field7 | String | Wildcard search on rules' modify_custom_field7 value. | [optional] |
| modify_skip_affiliate | Boolean | Filter to rules whose modify_skip_affiliate flag matches this value. | [optional] |
| modify_skip_affiliate_network_pixel | Boolean | Filter to rules whose modify_skip_affiliate_network_pixel flag matches this value. | [optional] |
| rule_group | String | Rule group to filter by. | [optional] |
| rule_type | String | Rule type to filter by. | [optional] |
| search_linked_accounts | Boolean | Include rules from accounts linked to this merchant. Defaults to false. | [optional] |
| storefront_hostname | String | Filter to rules with this storefront hostname in their screen_branding_theme_filters list. | [optional] |
| text_value | String | Wildcard search on the rule's text parameter (email / ip / bin / country / item id / avs codes - the backend disambiguates by rule_type). | [optional] |
| theme_code | String | Filter to rules with this screen branding theme code in their screen_branding_theme_filters list. | [optional] |
| user_action | String | [optional] |
-
Flag For Review(value:"Flag For Review") -
Process Payment and Modify(value:"Process Payment and Modify") -
Process Payment and Review(value:"Process Payment and Review") -
Decline Transaction(value:"Decline Transaction") -
Exempt(value:"Exempt")
-
exemptRules(value:"exemptRules") -
creditCardRules(value:"creditCardRules") -
ipRules(value:"ipRules") -
addressRules(value:"addressRules") -
affiliateRules(value:"affiliateRules") -
itemRules(value:"itemRules") -
orderRules(value:"orderRules") -
browserRules(value:"browserRules")
-
exempt apo fpo(value:"exempt apo fpo") -
exempt ip(value:"exempt ip") -
exempt logged in customer with pricing tier(value:"exempt logged in customer with pricing tier") -
credit card single transaction exceeds(value:"credit card single transaction exceeds") -
credit card daily transaction amount exceeds(value:"credit card daily transaction amount exceeds") -
credit card daily transaction count exceeds(value:"credit card daily transaction count exceeds") -
credit card weekly transaction amount exceeds(value:"credit card weekly transaction amount exceeds") -
credit card weekly transaction count exceeds(value:"credit card weekly transaction count exceeds") -
credit card change number(value:"credit card change number") -
credit card block bin(value:"credit card block bin") -
credit card block prepaid(value:"credit card block prepaid") -
amazon special instructions(value:"amazon special instructions") -
paypal special instructions(value:"paypal special instructions") -
reward coupon email mismatch(value:"reward coupon email mismatch") -
gateway response(value:"gateway response") -
ip daily transaction amount exceeds(value:"ip daily transaction amount exceeds") -
ip daily transaction count exceeds(value:"ip daily transaction count exceeds") -
ip weekly transaction amount exceeds(value:"ip weekly transaction amount exceeds") -
ip weekly transaction count exceeds(value:"ip weekly transaction count exceeds") -
ip matches(value:"ip matches") -
ip country mismatch(value:"ip country mismatch") -
address fraud score exceeds(value:"address fraud score exceeds") -
address fraud score exceeds exempt apo fpo(value:"address fraud score exceeds exempt apo fpo") -
address street and zip avs(value:"address street and zip avs") -
address billing doesnt match shipping(value:"address billing doesnt match shipping") -
billing country doesnt match shipping(value:"billing country doesnt match shipping") -
address international(value:"address international") -
address match except zip(value:"address match except zip") -
address email(value:"address email") -
address not in country(value:"address not in country") -
wholesale customer not logged in(value:"wholesale customer not logged in") -
affiliate matches(value:"affiliate matches") -
affiliate daily count exceeds(value:"affiliate daily count exceeds") -
affiliate weekly count exceeds(value:"affiliate weekly count exceeds") -
affiliate daily decline percentage exceeds(value:"affiliate daily decline percentage exceeds") -
affiliate weekly decline percentage exceeds(value:"affiliate weekly decline percentage exceeds") -
affiliate daily with same ip(value:"affiliate daily with same ip") -
affiliate weekly with same ip(value:"affiliate weekly with same ip") -
item matches(value:"item matches") -
item quantity exceeds(value:"item quantity exceeds") -
order previous return(value:"order previous return") -
order purchased within last hours(value:"order purchased within last hours") -
order used coupon meant for sharing(value:"order used coupon meant for sharing") -
browser os linux(value:"browser os linux")
-
Attempted(value:"Attempted") -
Approved(value:"Approved")