Profile - Retrieve Active Routing Algorithm

GET /v2/profiles/{id}/routing-algorithm

Retrieve the active routing algorithm configuration for a profile.

Example — cURL

curl

curl --request GET \
  --url https://sandbox.hyperswitch.io/v2/profiles/{id}/routing-algorithm \
  --header 'api-key: <api-key>'

Successful Response (200)

{
  "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.

Keep your API key secret. Do not embed it in client-side code or mobile apps.

Path Parameters

id (string) — required The unique identifier for the profile

Query Parameters

limit (integer | null) The number of records of the algorithms to be returned Required range: x >= 0
offset (integer | null) The record offset of the algorithm from which to start gathering the results Required range: x >= 0

Response

200 application/json — Successfully retrieved active config Response of the retrieved routing configs for a merchant account

Response object:

algorithm (object) — Routing Algorithm specific to merchants (see example above)

Good afternoon

Profile - Retrieve Active Routing Algorithm

Example — cURL

Successful Response (200)

Authorization

Path Parameters

Query Parameters

Response

Links