Skip to main content
POST
/
routing
Routing - Create
curl --request POST \
  --url https://sandbox.hyperswitch.io/routing \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "name": "default_card_routing",
  "description": "Primary routing strategy for card payments in Middle east",
  "algorithm": {
    "type": "single",
    "data": {
      "connector": "authipay",
      "merchant_connector_id": "<string>"
    }
  },
  "profile_id": "profile_123",
  "transaction_type": "payment"
}
'
{
  "id": "routing_abc123",
  "profile_id": "profile_123",
  "name": "india_card_routing",
  "kind": "single",
  "description": "Volume split routing for domestic transactions",
  "created_at": 1718000000000,
  "modified_at": 1718050000000,
  "algorithm_for": "payment",
  "decision_engine_routing_id": "de_route_456"
}

Authorizations

​
api-key
string
header
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.

Body

application/json
​
name
string | null

Unique name of the routing configuration.

This identifier is used to reference the routing config internally.

Example:

"default_card_routing"
Example:

"default_card_routing"

​
description
string | null

Optional human-readable description of the routing configuration.

Example:

"Primary routing strategy for card payments in India"
Example:

"Primary routing strategy for card payments in Middle east"

​
algorithm
object
​
profile_id
string | null

Profile ID associated with this routing configuration.

Routing configs can be scoped per business profile.

Example:

"profile_123"
Example:

"profile_123"

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

Response

Routing config created

Metadata record representing a stored routing configuration.

Used in routing dictionary listings.

​
id
string
required

Unique identifier of the routing configuration.

Example:

"routing_abc123"
Example:

"routing_abc123"

​
profile_id
string
required

Profile ID associated with this routing configuration.

Example:

"profile_123"
Example:

"profile_123"

​
name
string
required

Name of the routing configuration.

Example:

"india_card_routing"
Example:

"india_card_routing"

​
kind
enum<string>
required
Available options:
single,
priority,
volume_split,
advanced,
dynamic,
three_ds_decision_rule
​
description
string
required

Description of this routing configuration.

Example:

"Volume split routing for domestic transactions"
Example:

"Volume split routing for domestic transactions"

​
created_at
integer<int64>
required

Creation timestamp (milliseconds since epoch).

Example:

1718000000000

​
modified_at
integer<int64>
required

Last modification timestamp (milliseconds since epoch).

Example:

1718050000000

​
algorithm_for
enum<string>
Available options:
payment,
payout,
three_ds_authentication
​
decision_engine_routing_id
string | null

Associated Decision Engine routing identifier (if applicable).

Present when routing is linked to an external decision engine.

Example:

"de_route_456"
Example:

"de_route_456"