FraudAlertRule

Defines a Fraud Alert, including what conditions will trigger the alert, how, and to whom alert notifications will be sent.

event_suppression_period
Type: integer
min:
0
max:
31536000
required

How long, in seconds, after a fraud alert has been triggered to suppress duplicate events for the same alert and owner (e.g. Loyalty Enrollment).

Note: This value must be greater than or equal to the value of "time_period".
metric_type
Type: stringenum
required

What is being counted toward triggering a fraud alert.
values
- loyalty_enrollment_points_earned
- loyalty_enrollment_transactions
- loyalty_enrollment_retro_claims
name
Type: string
min length:
1
required

A unique identifier for the rule.
notify_corporate_contact
Type: boolean
required

A corporate/account contact will receive fraud alerts.
notify_emails
Type: boolean
required

Additional email addresses set by emails should receive fraud alerts.
notify_store_contact
Type: boolean
required

Contacts configured for the selected store(s) will receive fraud alerts.
quantity
Type: integer
min:
1
required

How many of the specified metric should trigger a fraud alert.
scope_type
Type: stringenum
required

Determines how selected stores contribute towards triggering a fraud alert. If all_stores is selected, activity in any of the selected stores will collectively count towards meeting the threshold (quantity), while one_store means that the threshold must be met within one of the locations.
values
- all_stores
- one_store
time_period
Type: integer
min:
3600
max:
31536000
required

The duration, in seconds, over which the quantity must be reached in order to trigger a fraud alert. This value may be between 1 hour and 365 days.
created_at
Type: stringFormat: date-time
read-only

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
description
Type: string
emails
Type: array string[] unique!

Additional email addresses that alert notifications should be sent to if notify_emails is set.
loyalty_program_id
Type: integer
min:
1

Required for Sparkfly Loyalty related fraud alerts, the ID of the Loyalty Program.
status
Type: stringenum
read-only

The current status of the fraud alert rule. Note: Archived rules cannot be reactivated, and rules can only be activated, suspended, and archived through "actions" API calls.
values
- pending
- active
- suspended
- archived
store_ids
Type: array integer[] unique!

The IDs of selected stores in which potentially fraudulent activity should be measured. If empty, any store will be considered.
updated_at
Type: stringFormat: date-time
read-only

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Examples

{
  "loyalty_program_id": 1,
  "name": "string",
  "description": "string",
  "status": "pending",
  "metric_type": "loyalty_enrollment_points_earned",
  "quantity": 1,
  "time_period": 3600,
  "scope_type": "all_stores",
  "event_suppression_period": 3600,
  "store_ids": [
    1
  ],
  "notify_store_contact": true,
  "notify_corporate_contact": true,
  "notify_emails": true,
  "emails": [
    "user@example.com"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}