List Rules | CrissCross

curl -G https://api.crisscross.money/v1/merchants/rules \
     -H "Content-Type: application/json" \
     -d merchantIds=merchantIds

[
  {
    "id": "d4f7a9b2-3c1e-4d5f-8a7b-9c0d1e2f3a4b",
    "name": "High Value Transaction Rule",
    "merchantId": "a3f1c9e2-7b4d-4f8a-9c2e-1d2f3b4a5c6d",
    "priority": 10,
    "isActive": true,
    "conditions": [
      {
        "name": "Transaction Amount",
        "operator": "greater_than",
        "datatype": "number",
        "value": 1000,
        "attributeKey": "amount"
      }
    ],
    "actions": [
      {
        "actionType": "select_processor",
        "processorId": "stripe"
      }
    ],
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-04-10T12:00:00Z"
  },
  {
    "id": "e7b3c2d1-4f5a-6b7c-8d9e-0f1a2b3c4d5e",
    "name": "Weekend Discount Rule",
    "merchantId": "b7e2d1f3-8c5a-4d9b-8e3f-2a1b4c5d6e7f",
    "priority": 5,
    "isActive": true,
    "conditions": [
      {
        "name": "Day of Week",
        "operator": "in",
        "datatype": "string",
        "value": [
          "Saturday",
          "Sunday"
        ],
        "attributeKey": "day"
      }
    ],
    "actions": [
      {
        "actionType": "apply_discount",
        "discountPercent": 15
      }
    ],
    "createdAt": "2024-02-01T08:00:00Z",
    "updatedAt": "2024-05-01T10:15:00Z"
  }
]

Retrieves a list of rules configured for one or more merchants.

Query parameters

merchantIdsstringRequired

Comma-separated list of merchant IDs.

Response

A list of rules.

idstring

Unique identifier for the rule.

namestring

Name of the rule.

merchantIdstringformat: "uuid"

Merchant identifier.

prioritydouble

Rule priority (higher precedence evaluated first).

isActiveboolean

Whether the rule is active.

conditionslist of objects

actionslist of objects

createdAtdatetime

Timestamp when the rule was created.

updatedAtdatetime

Timestamp when the rule was last updated.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error