FraudRuleCreateRequest

actionFraudRuleActionrequired

Possible values: [ALLOW, REVIEW, BLOCK, POST_AUTH_VOID, MONITOR]

baseRuleIdstring<uuid>nullable

channelsFraudRuleChannel[]nullable

Creation omission uses all channels. Nonempty server-authoritative channel scope.

Possible values: [CNP, CARD_PRESENT, KEYED, RECURRING], >= 1, <= 4

condition objectrequired

currencystringnullable

Possible values: Value must match regular expression [A-Za-z]{3}

entityFraudRuleEntityrequired

Possible values: [TRANSACTION, PAYMENT_CREDENTIAL, SOURCE_IP, CUSTOMER, BIN_IIN]

metricFraudRuleMetricrequired

Possible values: [AMOUNT, VELOCITY_COUNT, VELOCITY_AMOUNT, VELOCITY_DISTINCT_CREDENTIALS, SIGNAL, SAFE_TRANSACTION_SCORE]

modelVersionstringnullable

Required for SAFE_TRANSACTION_SCORE: payment-risk-v1, 0 lowest risk and 100 highest. Not an approval probability.

Possible values: [payment-risk-v1]

operatorFraudRuleOperatorrequired

Possible values: [GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, PRESENT]

signalFraudRuleSignalnullable

Possible values: [CARD_TESTING, BANK_ACCOUNT_TESTING, RECENT_DECLINE_BURST, RECENT_HIGH_RISK_SCORE, PRIOR_CHARGEBACK, CVV_MISMATCH, HIGH_RISK_COUNTRY, ADDRESS_MATCH, ADDRESS_MISMATCH, ADDRESS_UNAVAILABLE, ZIP_MATCH, ZIP_MISMATCH, ZIP_UNAVAILABLE, NAME_MATCH, NAME_MISMATCH, NAME_UNAVAILABLE, PHONE_MATCH, PHONE_MISMATCH, PHONE_UNAVAILABLE, EMAIL_MATCH, EMAIL_MISMATCH, EMAIL_UNAVAILABLE, IP_ADDRESS_MATCH, IP_ADDRESS_MISMATCH, IP_ADDRESS_UNAVAILABLE, NETWORK_ENHANCED_AUTH_AVAILABLE, NETWORK_ENHANCED_AUTH_UNAVAILABLE, NETWORK_ENHANCED_AUTH_UNKNOWN, RECAPTCHA_AUTOMATION, RECAPTCHA_UNEXPECTED_ENVIRONMENT, RECAPTCHA_TOO_MUCH_TRAFFIC, RECAPTCHA_UNEXPECTED_USAGE_PATTERNS, RECAPTCHA_LOW_CONFIDENCE, RECAPTCHA_HIGH_TRANSACTION_VELOCITY, RECAPTCHA_EXCESSIVE_ENUMERATION_PATTERN, RECAPTCHA_SHORT_IDENTITY_HISTORY, RECAPTCHA_GEOLOCATION_DISCREPANCY, RECAPTCHA_ASSOCIATED_WITH_FRAUD_CLUSTER, RECAPTCHA_STOLEN_INSTRUMENT_HIGH_RISK_V1, RECAPTCHA_CARD_TESTING_HIGH_RISK_V1, RECAPTCHA_LOW_BEHAVIORAL_TRUST_V1, RECAPTCHA_UNKNOWN]

stateFraudRuleStatenullable

Possible values: [ATTEMPTED, APPROVED, DECLINED, VERIFICATION_MISMATCH]

thresholdstringnullable

window objectnullable

durationinteger<int32>required

Possible values: > 0 and <= 2678400

unitFraudRuleWindowUnitrequired

Possible values: [SECONDS, MINUTES, HOURS, DAYS]

enabledbooleanrequired

namestringrequired

Possible values: <= 120 characters

priorityinteger<int32>required

Possible values: >= 0 and <= 1000000

reasonstringrequired

Possible values: <= 500 characters

scope objectrequired

processorProfileIdstring<uuid>nullable

typeFraudRuleScopeTyperequired

Possible values: [DEFAULT, PROCESSOR_PROFILE]

FraudRuleCreateRequest
{
  "action": "ALLOW",
  "baseRuleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "channels": [
    "CNP"
  ],
  "condition": {
    "currency": "string",
    "entity": "TRANSACTION",
    "metric": "AMOUNT",
    "modelVersion": "payment-risk-v1",
    "operator": "GREATER_THAN_OR_EQUAL",
    "signal": "CARD_TESTING",
    "state": "ATTEMPTED",
    "threshold": "string",
    "window": {
      "duration": 0,
      "unit": "SECONDS"
    }
  },
  "enabled": true,
  "name": "string",
  "priority": 0,
  "reason": "string",
  "scope": {
    "processorProfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "DEFAULT"
  }
}