🚧
Account configuration is required before testing transactions
If you are interested in access to this feature, please contact support@paymongo.com!

Retrieves a paginated list of all custom fraud rules configured for your organization. Each rule defines a set of conditions (such as risk score thresholds, country codes, payment amounts, etc.) and the action to take (allow, block, or review) when those conditions are met.

The endpoint returns rule metadata, logical operators, priority order, and the full set of conditions for each rule. Use this to audit your fraud strategy, visualize rule coverage, or synchronize rule definitions in external systems.

Example Response:

{
  "has_more": false,
  "data": [
    {
      "id": "frl_abcdefg123456",
      "type": "fraud.rule",
      "enabled": true,
      "name": "My 1st Rule",
      "operator": "AND",
      "rules": [
        {
          "rule_attribute": "risk_score_gte",
          "rule_value": "700"
        },
        {
          "rule_attribute": "card_country_id",
          "rule_value": ["NG"]
        }
      ],
      "action": "block",
      "rule_order": 1,
      "created_at": "2025-07-21T10:01:23.456Z",
      "updated_at": null
    },
    {
      "id": "frl_hijklmn123456",
      "type": "fraud.rule",
      "enabled": true,
      "name": "My 2nd Rule",
      "operator": "AND",
      "rules": [
        {
          "rule_attribute": "billing_country_id",
          "rule_value": "NG"
        }
      ],
      "action": "block",
      "rule_order": 2,
      "created_at": "2025-07-21T10:03:23.456Z",
      "updated_at": null
    }
  ]
}

attribute	description
`id`	Unique ID of the Rule resource
`type`	Resource type (`fraud.rule`)
`enabled`	Whether the rule is active
`name`	Name of the rule
`operator`	Logical operator for combining conditions (`AND` or `OR`)
`rules`	List of rule conditions (see below)
`action`	Action to take (`allow`, `block`, `review`)
`rule_order`	Priority order of the rule

Rule Condition Resource:

attribute	description
`rule_attribute`	Attribute evaluated (e.g., risk score, country)
`rule_value`	Value(s) for the condition