Skip to main content
GET
/
routing
Routing - List
curl --request GET \
  --url https://sandbox.hyperswitch.io/routing \
  --header 'api-key: <api-key>'
{
  "merchant_id": "merchant_789",
  "records": [
    {
      "id": "routing_abc123",
      "profile_id": "profile_123",
      "name": "india_card_routing",
      "kind": "single",
      "description": "Volume split routing for domestic transactions",
      "created_at": 1718000000000,
      "modified_at": 1718050000000,
      "algorithm_for": "payment",
      "decision_engine_routing_id": "de_route_456"
    }
  ],
  "active_id": "routing_abc123"
}

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.

Query Parameters

​
limit
integer<int32> | null

The number of records to be returned

Required range: x >= 0
​
offset
integer<int32> | null

The record offset from which to start gathering of results

Required range: x >= 0
​
profile_id
string | null

The unique identifier for a merchant profile

Response

Successfully fetched routing configs

Routing dictionary for a merchant.

Contains all routing configurations created by the merchant, along with the currently active routing configuration.

​
merchant_id
string
required

Unique merchant identifier.

Example:

"merchant_789"
Example:

"merchant_789"

​
records
object[]
required

List of all routing configuration records associated with this merchant.

​
active_id
string | null

Currently active routing configuration ID.

Example:

"routing_abc123"
Example:

"routing_abc123"