Skip to main content
GET
/
v2
/
routing-algorithms
/
{id}
Routing - Retrieve
curl --request GET \
  --url https://sandbox.hyperswitch.io/v2/routing-algorithms/{id} \
  --header 'Authorization: <api-key>'
{
  "id": "routing_abc123",
  "profile_id": "profile_123",
  "name": "default_card_routing",
  "description": "Primary routing strategy for card payments",
  "algorithm": {
    "type": "single",
    "data": {
      "connector": "authipay",
      "merchant_connector_id": "<string>"
    }
  },
  "created_at": 1718000000000,
  "modified_at": 1718050000000,
  "algorithm_for": "payment"
}

Authorizations

​
Authorization
string
header
required

Format: api-key=<api_key>

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.

Path Parameters

​
id
string
required

The unique identifier for a routing algorithm

Response

Successfully fetched routing algorithm

Routing algorithm configuration created for a merchant.

Represents a fully defined routing strategy scoped to a profile and transaction type.

​
id
string
required

Unique identifier of the routing configuration.

Example:

"routing_abc123"
Example:

"routing_abc123"

​
profile_id
string
required

Profile ID to which this routing configuration belongs.

Example:

"profile_123"
Example:

"profile_123"

​
name
string
required

Human-readable name of the routing configuration.

Example:

"default_card_routing"
Example:

"default_card_routing"

​
description
string
required

Description explaining the purpose of this routing configuration.

Example:

"Primary routing strategy for card payments"
Example:

"Primary routing strategy for card payments"

​
algorithm
object
required
​
created_at
integer<int64>
required

Timestamp (in milliseconds since epoch) when the routing configuration was created.

Example:

1718000000000
Example:

1718000000000

​
modified_at
integer<int64>
required

Timestamp (in milliseconds since epoch) when the routing configuration was last modified.

Example:

1718050000000
Example:

1718050000000

​
algorithm_for
enum<string>
required
Available options:
payment,
payout,
three_ds_authentication