Skip to main content

Search Fraud Rules

The endpoint and HTTP method information used for searching rules are provided below.

URL

GET/fraud/v1/rules

Request Parameters

The parameters expected to be sent in requests for rule searching are listed in the table and subheadings below.

name
string

Rule name

minCreatedDate
date

Minimum creation date of the rule

maxCreatedDate
date

Maximum creation date of the rule

action
FraudAction

Fraud Actions

Values:
BLOCK
REVIEW
operation
Operation

Operation type

Values:
PAYMENT
LOYALTY
page
number

Page number for pagination

size
number

Page size for pagination

Response Parameters

The parameters returned as a result of the rule searching process are subject to the rules specified in the Response Formats section on the API documentation introduction page. If there is no systemic or logical error, the sub-parameters of the object returned in the data parameter are as follows:

id
number

Rule ID

status
string

Status of the rule

Values:
ACTIVE
PASSIVE
name
string

Rule name

action
FraudAction

Action

Values:
BLOCK
REVIEW
conditions
string

Conditions

operations
Operation[]

Operation Types

Values:
PAYMENT
LOYALTY

Sample Codes

You can review the sample codes in the open-source Craftgate API clients.

Search Fraud Rules