Skip to main content
POST
/
v2
/
routing-algorithms
Routing - Create
curl --request POST \
  --url https://sandbox.birrpay.io/v2/routing-algorithms \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "algorithm": {
    "data": {
      "merchant_connector_id": "<string>"
    }
  },
  "profile_id": "<string>"
}
'
{
  "id": "<string>",
  "profile_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "created_at": 123,
  "modified_at": 123,
  "decision_engine_routing_id": "<string>"
}

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.

Body

application/json
​
name
string
required
​
description
string
required
​
algorithm
object
required
​
profile_id
string
required

Response

Routing Algorithm created

​
id
string
required
​
profile_id
string
required
​
name
string
required
​
kind
enum<string>
required
Available options:
single,
priority,
volume_split,
advanced,
dynamic,
three_ds_decision_rule
​
description
string
required
​
created_at
integer<int64>
required
​
modified_at
integer<int64>
required
​
algorithm_for
enum<string>
Available options:
payment,
payout,
three_ds_authentication
​
decision_engine_routing_id
string | null