| Name | Type | Description | Notes |
|---|---|---|---|
| affiliateOid | Integer | Affiliate oid for the 'affiliate matches' rule type. | [optional] |
| amountThreshold | BigDecimal | Monetary or score threshold for amount/score/percentage rule types. | [optional] |
| autoNote | String | Note automatically appended to the order's merchant note when this rule fires. | [optional] |
| avsMatchType | AvsMatchTypeEnum | [optional] | |
| avsResponseCodes | String | AVS response codes for the 'address street and zip avs' rule type. | [optional] |
| cardNumber | String | Masked credit card number for rules tied to a specific card | [optional] |
| countThreshold | Integer | Integer count threshold for count/quantity/hours rule types. | [optional] |
| countryCode | String | ISO country code for the 'address not in country' rule type. | [optional] |
| createdBy | String | [optional] | |
| createdDts | String | Created date | [optional] |
| creditCardBins | List<String> | Credit card BINs blocked by the 'credit card block bin' rule type. | [optional] |
| declineMessage | String | Message shown in the A/R review screen when this rule fires. | [optional] |
| description | String | Human-readable description of the rule | [optional] |
| descriptionHtml | String | HTML version of the rule description | [optional] |
| String | Email address for the 'address email' rule type. | [optional] | |
| failureAction | FailureActionEnum | Action taken when this rule fires. | [optional] |
| fraudRuleOid | Integer | UltraCart unique identifier for this fraud rule | [optional] |
| gatewayResponseCodes | String | Gateway response code key for the 'gateway response' rule type. | [optional] |
| gatewayResponseValue | String | Gateway response code value for the 'gateway response' rule type. | [optional] |
| ipAddress | String | IP address or subnet for 'exempt ip' and 'ip matches' rule types. | [optional] |
| ipRangeType | IpRangeTypeEnum | [optional] | |
| itemFilters | List<FraudRuleItemFilter> | Item filters restricting this rule to orders containing one or more of these items. | [optional] |
| merchantItemId | String | Merchant item id for the 'item matches' rule type. | [optional] |
| modifyCustomField1 | String | Value the rule sets on order custom field 1 (only meaningful for 'Process Payment and Modify'). | [optional] |
| modifyCustomField2 | String | Value the rule sets on order custom field 2 (only meaningful for 'Process Payment and Modify'). | [optional] |
| modifyCustomField3 | String | Value the rule sets on order custom field 3 (only meaningful for 'Process Payment and Modify'). | [optional] |
| modifyCustomField4 | String | Value the rule sets on order custom field 4 (only meaningful for 'Process Payment and Modify'). | [optional] |
| modifyCustomField5 | String | Value the rule sets on order custom field 5 (only meaningful for 'Process Payment and Modify'). | [optional] |
| modifyCustomField6 | String | Value the rule sets on order custom field 6 (only meaningful for 'Process Payment and Modify'). | [optional] |
| modifyCustomField7 | String | Value the rule sets on order custom field 7 (only meaningful for 'Process Payment and Modify'). | [optional] |
| modifySkipAffiliate | Boolean | When true, the rule strips the affiliate from the order (only meaningful for 'Process Payment and Modify'). | [optional] |
| modifySkipAffiliateNetworkPixel | Boolean | When true, the rule suppresses the affiliate network pixel (only meaningful for 'Process Payment and Modify'). | [optional] |
| rotatingTransactionGatewayFilters | List<FraudRuleRotatingTransactionGatewayFilter> | Gateway filters restricting this rule to orders processed by one of these rotating transaction gateways. | [optional] |
| ruleGroup | String | Group containing this rule type (eg 'creditCardRules'). Deliberately not constrained by allowableValues on the response so SDK consumers do not hard-fail on an unexpected value if a future rule_type slips through the server-side mapping. Search REQUESTS still restrict rule_group to the known set. | [optional] |
| ruleType | RuleTypeEnum | Rule type. | [optional] |
| storefrontFilters | List<FraudRuleStorefrontFilter> | Storefront filters restricting this rule to orders placed on one of these storefronts. | [optional] |
| userAction | UserActionEnum | [optional] |
| Name | Value |
|---|---|
| MATCH | "match" |
| NO_MATCH | "no match" |
| PARTIAL | "partial" |
| 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 |
|---|---|
| ADDRESS | "address" |
| SUBNET | "subnet" |
| 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" |