| Name | Type | Description | Notes |
|---|---|---|---|
| affiliateOidOrEmail | String | Affiliate oid (integer) or affiliate email. Email is resolved to oid before searching. | [optional] |
| amountThresholdBegin | BigDecimal | Lower bound on amount/score/percentage thresholds (rules backed by the same numeric column). | [optional] |
| amountThresholdEnd | BigDecimal | Upper bound on amount/score/percentage thresholds (rules backed by the same numeric column). | [optional] |
| autoNote | String | Wildcard search on the rule's auto_note. Use '*' for wildcards. | [optional] |
| countThresholdBegin | Integer | Lower bound on count thresholds (rules backed by the same integer count column). | [optional] |
| countThresholdEnd | Integer | Upper bound on count thresholds (rules backed by the same integer count column). | [optional] |
| createdBy | String | Filter to rules created by this user login. | [optional] |
| createdDateBegin | String | Rule creation date begin (MM/dd/yyyy) | [optional] |
| createdDateEnd | String | Rule creation date end (MM/dd/yyyy) | [optional] |
| creditCardPartial | String | Partial credit card number for matching 'credit card matches' rules. Use '*' wildcards. | [optional] |
| declineMessage | String | Wildcard search on the rule's decline_message. Use '*' for wildcards. | [optional] |
| failureAction | FailureActionEnum | [optional] | |
| gatewayCode | String | Filter to rules with this rotating transaction gateway code in their rotating_transaction_gateway_filters list. | [optional] |
| merchantItemId | String | Filter to rules with this merchant item id in their item_filters list. | [optional] |
| modifierValue | String | Wildcard search on the rule's secondary modifier (eg 'address'/'subnet', gateway codes, avs match types). | [optional] |
| modifyCustomField1 | String | Wildcard search on rules' modify_custom_field1 value. | [optional] |
| modifyCustomField2 | String | Wildcard search on rules' modify_custom_field2 value. | [optional] |
| modifyCustomField3 | String | Wildcard search on rules' modify_custom_field3 value. | [optional] |
| modifyCustomField4 | String | Wildcard search on rules' modify_custom_field4 value. | [optional] |
| modifyCustomField5 | String | Wildcard search on rules' modify_custom_field5 value. | [optional] |
| modifyCustomField6 | String | Wildcard search on rules' modify_custom_field6 value. | [optional] |
| modifyCustomField7 | String | Wildcard search on rules' modify_custom_field7 value. | [optional] |
| modifySkipAffiliate | Boolean | Filter to rules whose modify_skip_affiliate flag matches this value. | [optional] |
| modifySkipAffiliateNetworkPixel | Boolean | Filter to rules whose modify_skip_affiliate_network_pixel flag matches this value. | [optional] |
| ruleGroup | RuleGroupEnum | Rule group to filter by. | [optional] |
| ruleType | RuleTypeEnum | Rule type to filter by. | [optional] |
| searchLinkedAccounts | Boolean | Include rules from accounts linked to this merchant. Defaults to false. | [optional] |
| storefrontHostname | String | Filter to rules with this storefront hostname in their screen_branding_theme_filters list. | [optional] |
| textValue | String | Wildcard search on the rule's text parameter (email / ip / bin / country / item id / avs codes - the backend disambiguates by rule_type). | [optional] |
| themeCode | String | Filter to rules with this screen branding theme code in their screen_branding_theme_filters list. | [optional] |
| userAction | UserActionEnum | [optional] |
| Name | Value |
|---|---|
| FLAG_FOR_REVIEW | "Flag For Review" |
| PROCESS_PAYMENT_AND_MODIFY | "Process Payment and Modify" |
| PROCESS_PAYMENT_AND_REVIEW | "Process Payment and Review" |
| DECLINE_TRANSACTION | "Decline Transaction" |
| EXEMPT | "Exempt" |
| Name | Value |
|---|---|
| EXEMPTRULES | "exemptRules" |
| CREDITCARDRULES | "creditCardRules" |
| IPRULES | "ipRules" |
| ADDRESSRULES | "addressRules" |
| AFFILIATERULES | "affiliateRules" |
| ITEMRULES | "itemRules" |
| ORDERRULES | "orderRules" |
| BROWSERRULES | "browserRules" |
| Name | Value |
|---|---|
| EXEMPT_APO_FPO | "exempt apo fpo" |
| EXEMPT_IP | "exempt ip" |
| EXEMPT_LOGGED_IN_CUSTOMER_WITH_PRICING_TIER | "exempt logged in customer with pricing tier" |
| CREDIT_CARD_SINGLE_TRANSACTION_EXCEEDS | "credit card single transaction exceeds" |
| CREDIT_CARD_DAILY_TRANSACTION_AMOUNT_EXCEEDS | "credit card daily transaction amount exceeds" |
| CREDIT_CARD_DAILY_TRANSACTION_COUNT_EXCEEDS | "credit card daily transaction count exceeds" |
| CREDIT_CARD_WEEKLY_TRANSACTION_AMOUNT_EXCEEDS | "credit card weekly transaction amount exceeds" |
| CREDIT_CARD_WEEKLY_TRANSACTION_COUNT_EXCEEDS | "credit card weekly transaction count exceeds" |
| CREDIT_CARD_CHANGE_NUMBER | "credit card change number" |
| CREDIT_CARD_BLOCK_BIN | "credit card block bin" |
| CREDIT_CARD_BLOCK_PREPAID | "credit card block prepaid" |
| AMAZON_SPECIAL_INSTRUCTIONS | "amazon special instructions" |
| PAYPAL_SPECIAL_INSTRUCTIONS | "paypal special instructions" |
| REWARD_COUPON_EMAIL_MISMATCH | "reward coupon email mismatch" |
| GATEWAY_RESPONSE | "gateway response" |
| IP_DAILY_TRANSACTION_AMOUNT_EXCEEDS | "ip daily transaction amount exceeds" |
| IP_DAILY_TRANSACTION_COUNT_EXCEEDS | "ip daily transaction count exceeds" |
| IP_WEEKLY_TRANSACTION_AMOUNT_EXCEEDS | "ip weekly transaction amount exceeds" |
| IP_WEEKLY_TRANSACTION_COUNT_EXCEEDS | "ip weekly transaction count exceeds" |
| IP_MATCHES | "ip matches" |
| IP_COUNTRY_MISMATCH | "ip country mismatch" |
| ADDRESS_FRAUD_SCORE_EXCEEDS | "address fraud score exceeds" |
| ADDRESS_FRAUD_SCORE_EXCEEDS_EXEMPT_APO_FPO | "address fraud score exceeds exempt apo fpo" |
| ADDRESS_STREET_AND_ZIP_AVS | "address street and zip avs" |
| ADDRESS_BILLING_DOESNT_MATCH_SHIPPING | "address billing doesnt match shipping" |
| BILLING_COUNTRY_DOESNT_MATCH_SHIPPING | "billing country doesnt match shipping" |
| ADDRESS_INTERNATIONAL | "address international" |
| ADDRESS_MATCH_EXCEPT_ZIP | "address match except zip" |
| ADDRESS_EMAIL | "address email" |
| ADDRESS_NOT_IN_COUNTRY | "address not in country" |
| WHOLESALE_CUSTOMER_NOT_LOGGED_IN | "wholesale customer not logged in" |
| AFFILIATE_MATCHES | "affiliate matches" |
| AFFILIATE_DAILY_COUNT_EXCEEDS | "affiliate daily count exceeds" |
| AFFILIATE_WEEKLY_COUNT_EXCEEDS | "affiliate weekly count exceeds" |
| AFFILIATE_DAILY_DECLINE_PERCENTAGE_EXCEEDS | "affiliate daily decline percentage exceeds" |
| AFFILIATE_WEEKLY_DECLINE_PERCENTAGE_EXCEEDS | "affiliate weekly decline percentage exceeds" |
| AFFILIATE_DAILY_WITH_SAME_IP | "affiliate daily with same ip" |
| AFFILIATE_WEEKLY_WITH_SAME_IP | "affiliate weekly with same ip" |
| ITEM_MATCHES | "item matches" |
| ITEM_QUANTITY_EXCEEDS | "item quantity exceeds" |
| ORDER_PREVIOUS_RETURN | "order previous return" |
| ORDER_PURCHASED_WITHIN_LAST_HOURS | "order purchased within last hours" |
| ORDER_USED_COUPON_MEANT_FOR_SHARING | "order used coupon meant for sharing" |
| BROWSER_OS_LINUX | "browser os linux" |
| Name | Value |
|---|---|
| ATTEMPTED | "Attempted" |
| APPROVED | "Approved" |