Routing - List

GET /routing

Description: Fetch routing configurations for a merchant.

Try it:

curl --request GET \
  --url https://sandbox.hyperswitch.io/routing \
  --header 'api-key: <api-key>'

Response (200):

{
  "merchant_id": "<string>",
  "records": [
    {
      "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>"
    }
  ],
  "active_id": "<string>"
}

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. Do not expose this key on a website or embed it in a mobile application.

(Also supports jwt_key as an alternative authorization mechanism.)

Query parameters

  • limit — integer | null The number of records to be returned. Required range: x >= 0

  • offset — integer | null The record offset from which to start gathering results. Required range: x >= 0

  • profile_id — string | null The unique identifier for a merchant profile

Response

200 application/json — Successfully fetched routing configs

Top-level object properties:

  • merchant_id (string) — required

  • records (array of objects) — required

  • active_id (string | null)

records[] object attributes

Each object in records may contain:

  • id (string)

  • profile_id (string)

  • name (string)

  • kind (string) — e.g., "single"

  • description (string)

  • created_at (number) — timestamp

  • modified_at (number) — timestamp

  • algorithm_for (string) — e.g., "payment"

  • decision_engine_routing_id (string)

Links

  • Documentation home: https://api-reference.hyperswitch.io/introduction

  • Locker API Reference: https://api-reference.hyperswitch.io/locker-api-reference/overview

  • Intelligent Router API Reference: https://api-reference.hyperswitch.io/intelligent-router-api-reference/overview

  • Edit this page: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/routing/routing--list.mdx

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

PreviousroutingNextapi-key