Skip to main content
GET
/
v2
/
profiles
/
{id}
/
routing-algorithm
Profile - Retrieve Active Routing Algorithm
curl --request GET \
  --url https://sandbox.hyperswitch.io/v2/profiles/{id}/routing-algorithm \
  --header 'Authorization: <api-key>'
{
  "algorithm": {
    "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 the profile

Query Parameters

limit
integer<int32> | null

The number of records of the algorithms to be returned

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

The record offset of the algorithm from which to start gathering the results

Required range: x >= 0

Response

Successfully retrieved active config

Response returned when retrieving routing configuration for a merchant account.

algorithm
object

Routing algorithm configuration created for a merchant.

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