Routing - Rule Evaluate

Endpoint: POST /routing/rule/evaluate

cURL example

curl --request POST \
  --url https://sandbox.hyperswitch.io/routing/rule/evaluate \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "created_by": "<string>",
  "parameters": {},
  "fallback_output": [
    {
      "gateway_name": "authipay",
      "gateway_id": "<string>"
    }
  ]
}
'

Successful response (200)

{
  "status": "<string>",
  "output": "<unknown>",
  "evaluated_output": [
    {
      "connector": "authipay",
      "merchant_connector_id": "<string>"
    }
  ],
  "eligible_connectors": [
    {
      "connector": "authipay",
      "merchant_connector_id": "<string>"
    }
  ]
}

---

Authorizations

• api-key (string, header, required)

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Keep your API key secret. Do not embed it in client-side applications or public repositories.

---

Request Body (application/json)

• created_by (string, required)

• parameters (object, required) Parameters that can be used in the routing evaluate request. Example structure:

{
  "parameters": {
    "payment_method": { "type": "enum_variant", "value": "card" },
    "payment_method_type": { "type": "enum_variant", "value": "credit" },
    "amount": { "type": "number", "value": 10 },
    "currency": { "type": "str_value", "value": "INR" },
    "authentication_type": { "type": "enum_variant", "value": "three_ds" },
    "card_bin": { "type": "str_value", "value": "424242" },
    "capture_method": { "type": "enum_variant", "value": "scheduled" },
    "business_country": { "type": "str_value", "value": "IN" },
    "billing_country": { "type": "str_value", "value": "IN" },
    "business_label": { "type": "str_value", "value": "business_label" },
    "setup_future_usage": { "type": "enum_variant", "value": "off_session" },
    "card_network": { "type": "enum_variant", "value": "visa" },
    "payment_type": { "type": "enum_variant", "value": "recurring_mandate" },
    "mandate_type": { "type": "enum_variant", "value": "single_use" },
    "mandate_acceptance_type": { "type": "enum_variant", "value": "online" },
    "metadata": { "type": "metadata_variant", "value": { "key": "key1", "value": "value1" } }
  }
}

• fallback_output (object[], required) Array of fallback outputs. Example element:

{
  "gateway_name": "authipay",
  "gateway_id": "<string>"
}

---

Response (200 application/json)

Routing rules evaluated successfully.

• status (string, required)

• output (any, required)

• evaluated_output (object[], required) — evaluated routing outputs

• eligible_connectors (object[], required) — connectors considered eligible

Each object in evaluated_output / eligible_connectors may contain fields like:

• connector

• merchant_connector_id

---

Was this page helpful?

• Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/routing/routing--rule-evaluate.mdx

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

Related:

• Routing - Feedback: https://api-reference.hyperswitch.io/v1/routing/routing--feedback

• Relay - Create: https://api-reference.hyperswitch.io/v1/relay/relay