Routing - Deactivate

Deactivate a routing configuration.

Endpoint

• POST https://sandbox.hyperswitch.io/routing/deactivate

cURL

curl

curl --request POST \
  --url https://sandbox.hyperswitch.io/routing/deactivate \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "algorithm": {
    "type": "single",
    "data": {
      "connector": "authipay",
      "merchant_connector_id": "<string>"
    }
  },
  "profile_id": "<string>",
  "transaction_type": "payment"
}
'

Authorization

Header: api-key (string) — 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.

Request (application/json)

Fields:

• name — string | null

• description — string | null

• algorithm — object

  • (This object has child attributes; see expandable section below.)

• profile_id — string | null

• transaction_type — enum Available options: payment, payout, three_ds_authentication

algorithm object (child attributes)

Example structure shown in the cURL above:

{ "type": "single", "data": { "connector": "authipay", "merchant_connector_id": "" } }

The original doc lists multiple algorithm options (Option 1 through Option 5). Refer to your API reference for full algorithm schema and possible types such as single, priority, volume_split, advanced, dynamic, etc.

Response (200 — application/json)

Successfully deactivated routing config. Example response:

response.json

{
  "id": "<string>",
  "profile_id": "<string>",
  "name": "<string>",
  "kind": "single",
  "description": "<string>",
  "created_at": 123,
  "modified_at": 123,
  "algorithm_for": "payment",
  "decision_engine_routing_id": "<string>"
}

Response fields:

• id — string (required)

• profile_id — string (required)

• name — string (required)

• kind — enum (required) Available options: single, priority, volume_split, advanced, dynamic, three_ds_decision_rule

• description — string (required)

• created_at — integer (required)

• modified_at — integer (required)

• algorithm_for — enum Available options: payment, payout, three_ds_authentication

• decision_engine_routing_id — string | null

---

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/routing/routing--deactivate.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/routing/routing--deactivate