curl --request GET \
--url https://sandbox.hyperswitch.io/routing/{routing_algorithm_id} \
--header 'api-key: <api-key>'import requests
url = "https://sandbox.hyperswitch.io/routing/{routing_algorithm_id}"
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/{routing_algorithm_id}', 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/{routing_algorithm_id}",
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/{routing_algorithm_id}"
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/{routing_algorithm_id}")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hyperswitch.io/routing/{routing_algorithm_id}")
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{
"id": "routing_abc123",
"profile_id": "profile_123",
"name": "default_card_routing",
"description": "Primary routing strategy for card payments",
"algorithm": {
"type": "single",
"data": {
"connector": "absa_sanlam",
"merchant_connector_id": "<string>"
}
},
"created_at": 1718000000000,
"modified_at": 1718050000000,
"algorithm_for": "payment"
}Routing - Retrieve
Retrieve a routing algorithm
curl --request GET \
--url https://sandbox.hyperswitch.io/routing/{routing_algorithm_id} \
--header 'api-key: <api-key>'import requests
url = "https://sandbox.hyperswitch.io/routing/{routing_algorithm_id}"
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/{routing_algorithm_id}', 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/{routing_algorithm_id}",
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/{routing_algorithm_id}"
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/{routing_algorithm_id}")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hyperswitch.io/routing/{routing_algorithm_id}")
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{
"id": "routing_abc123",
"profile_id": "profile_123",
"name": "default_card_routing",
"description": "Primary routing strategy for card payments",
"algorithm": {
"type": "single",
"data": {
"connector": "absa_sanlam",
"merchant_connector_id": "<string>"
}
},
"created_at": 1718000000000,
"modified_at": 1718050000000,
"algorithm_for": "payment"
}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.
Path Parameters
The unique identifier for a config
Response
Successfully fetched routing config
Routing algorithm configuration created for a merchant.
Represents a fully defined routing strategy scoped to a profile and transaction type.
Unique identifier of the routing configuration.
Example:
"routing_abc123"
"routing_abc123"
Profile ID to which this routing configuration belongs.
Example:
"profile_123"
"profile_123"
Human-readable name of the routing configuration.
Example:
"default_card_routing"
"default_card_routing"
Description explaining the purpose of this routing configuration.
Example:
"Primary routing strategy for card payments"
"Primary routing strategy for card payments"
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
Show child attributes
Show child attributes
Timestamp (in milliseconds since epoch) when the routing configuration was created.
Example:
1718000000000
1718000000000
Timestamp (in milliseconds since epoch) when the routing configuration was last modified.
Example:
1718050000000
1718050000000
payment, payout, three_ds_authentication