Evaluate an existing routing Rule

Evaluate a routing rule by calling the Euclid Evaluate endpoint.

cURL

curl --request POST \
  --url https://api.example.com/euclid.EuclidService/Evaluate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-profile-id: <x-profile-id>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "algorithm_id": "routing_ec1ac351-7944-440f-bdc7-6a500df1116f",
  "parameters": {
    "payment_method": {
      "type": "enum_variant",
      "value": "card"
    },
    "amount": {
      "type": "number",
      "value": 2000
    }
  }
}
'

Example success response (200)

Response (application/json)

{
  "status": "success",
  "output": {
    "priority": {
      "connectors": [
        "stripe",
        "adyen"
      ]
    }
  },
  "evaluated_output": [
    "stripe"
  ],
  "eligible_connectors": []
}

HTTP

POST / euclid.EuclidService / Evaluate

Headers

• x-tenant-id (string) — required

• x-profile-id (string) — required

• x-api-key (string) — required

Body (application/json)

• algorithm_id (string) Example: "routing_ec1ac351-7944-440f-bdc7-6a500df1116f"

• parameters (object) — example shape:

{
  "payment_method": { "type": "enum_variant", "value": "card" },
  "amount": { "type": "number", "value": 1500 }
}

Response (200, application/json)

Evaluation result fields:

• status (string)

• output (object) — e.g. { "connectors": ["stripe", "adyen"] }

• evaluated_output (string[])

• eligible_connectors (string[])

Links

• Edit this page: https://github.com/juspay/hyperswitch/edit/main/api-reference/intelligent-router-api-reference/static-routing/evaluate-routing-rule.mdx

• Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/intelligent-router-api-reference/static-routing/evaluate-routing-rule

• Create a routing Rule: https://api-reference.hyperswitch.io/intelligent-router-api-reference/static-routing/create-a-routing-rule