Routing - Retrieve Config

GET /routing/active

Retrieve the active routing configuration for a merchant account.

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

Response (200)

Content-Type: application/json Description: Successfully retrieved active config

Example body:

{
  "algorithm": {
    "id": "<string>",
    "profile_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "algorithm": {
      "type": "single",
      "data": {
        "connector": "authipay",
        "merchant_connector_id": "<string>"
      }
    },
    "created_at": 123,
    "modified_at": 123,
    "algorithm_for": "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.

Do not expose the API key in client-side code (web or mobile). Keep it on your server.

Query Parameters

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

Response Schema (summary)

  • algorithm (object): Routing algorithm specific to merchants

    • id

    • profile_id

    • name

    • description

    • algorithm (object)

      • type

      • data

        • connector

        • merchant_connector_id

    • created_at

    • modified_at

    • algorithm_for

Related

  • Routing - Elimination: https://api-reference.hyperswitch.io/v1/routing/routing--elimination

  • Routing - Deactivate: https://api-reference.hyperswitch.io/v1/routing/routing--deactivate

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

PreviousSubscription - RetrieveNextGsm - Delete