curl --request GET \
--url https://sandbox.hyperswitch.io/routing \
--header 'api-key: <api-key>'import requests
url = "https://sandbox.hyperswitch.io/routing"
headers = {"api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'api-key': '<api-key>'}};
fetch('https://sandbox.hyperswitch.io/routing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.hyperswitch.io/routing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.hyperswitch.io/routing"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.hyperswitch.io/routing")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hyperswitch.io/routing")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"merchant_id": "merchant_789",
"records": [
{
"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"
}
],
"active_id": "routing_abc123"
}Routing - List
List all routing configs
curl --request GET \
--url https://sandbox.hyperswitch.io/routing \
--header 'api-key: <api-key>'import requests
url = "https://sandbox.hyperswitch.io/routing"
headers = {"api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'api-key': '<api-key>'}};
fetch('https://sandbox.hyperswitch.io/routing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.hyperswitch.io/routing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.hyperswitch.io/routing"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.hyperswitch.io/routing")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hyperswitch.io/routing")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"merchant_id": "merchant_789",
"records": [
{
"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"
}
],
"active_id": "routing_abc123"
}Authorizations
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.
Query Parameters
The number of records to be returned
x >= 0The record offset from which to start gathering of results
x >= 0The unique identifier for a merchant profile
Response
Successfully fetched routing configs
- object
- object[]
Routing dictionary for a merchant.
Contains all routing configurations created by the merchant, along with the currently active routing configuration.
Unique merchant identifier.
Example:
"merchant_789"
"merchant_789"
List of all routing configuration records associated with this merchant.
Show child attributes
Show child attributes
Currently active routing configuration ID.
Example:
"routing_abc123"
"routing_abc123"