Routing - Retrieve

GET /routing/{routing_algorithm_id}

Retrieve a routing configuration.

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

Success response (200)

Content-Type: application/json

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

Path parameters

  • routing_algorithm_id (string, required) — The unique identifier for a config

Response schema

  • id — string (required)

  • profile_id — string (required)

  • name — string (required)

  • description — string (required)

  • algorithm — object (required)

    • Example:

      • type: "single"

      • data:

        • connector: "authipay"

        • merchant_connector_id: ""

    • Option 1

    • Option 2

    • Option 3

    • Option 4

    • Option 5

    • Option 6

    • Option 7

    • Option 8

  • created_at — integer (required)

  • modified_at — integer (required)

  • algorithm_for — enum (required) — Available options: payment, payout, three_ds_authentication

Related links

  • Documentation: 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--retrieve.mdx

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

PreviousAPI Key - RetrieveNextPayouts - Update