Profile - Activate routing algorithm

PATCH /v2/profiles/{id}/activate-routing-algorithm

Activate a routing algorithm for a profile.

cURL

curl --request PATCH \
  --url https://sandbox.hyperswitch.io/v2/profiles/{id}/activate-routing-algorithm \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "routing_algorithm_id": "routing_algorithm_123"
}
'

Response (200)

{
  "id": "<string>",
  "profile_id": "<string>",
  "name": "<string>",
  "kind": "single",
  "description": "<string>",
  "created_at": 123,
  "modified_at": 123,
  "algorithm_for": "payment",
  "decision_engine_routing_id": "<string>"
}

Authorizations

• api-key (header, 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.

Path Parameters

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

Body (application/json)

• routing_algorithm_id (string) — required

Example body:

{
  "routing_algorithm_id": "routing_algorithm_123"
}

Response Fields

• id (string) — required

• profile_id (string) — required

• name (string) — required

• kind (enum) — required Available options: single, priority, volume_split, advanced, dynamic, three_ds_decision_rule

• description (string) — required

• created_at (integer) — required

• modified_at (integer) — required

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

• decision_engine_routing_id (string | null)

Notes

Routing Algorithm is activated on success (200).

---

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