Routing - Update Default For Profile
curl --request POST \
--url https://sandbox.hyperswitch.io/routing/default/profile/{profile_id} \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
[
{
"merchant_connector_id": "<string>"
}
]
'import requests
url = "https://sandbox.hyperswitch.io/routing/default/profile/{profile_id}"
payload = [{ "merchant_connector_id": "<string>" }]
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([{merchant_connector_id: '<string>'}])
};
fetch('https://sandbox.hyperswitch.io/routing/default/profile/{profile_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/default/profile/{profile_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'merchant_connector_id' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.hyperswitch.io/routing/default/profile/{profile_id}"
payload := strings.NewReader("[\n {\n \"merchant_connector_id\": \"<string>\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.hyperswitch.io/routing/default/profile/{profile_id}")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"merchant_connector_id\": \"<string>\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hyperswitch.io/routing/default/profile/{profile_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"merchant_connector_id\": \"<string>\"\n }\n]"
response = http.request(request)
puts response.read_body{
"profile_id": "profile_123",
"connectors": [
{
"connector": "absa_sanlam",
"merchant_connector_id": "<string>"
}
]
}Routing
Routing - Update Default For Profile
Update default config for profiles
POST
/
routing
/
default
/
profile
/
{profile_id}
Routing - Update Default For Profile
curl --request POST \
--url https://sandbox.hyperswitch.io/routing/default/profile/{profile_id} \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
[
{
"merchant_connector_id": "<string>"
}
]
'import requests
url = "https://sandbox.hyperswitch.io/routing/default/profile/{profile_id}"
payload = [{ "merchant_connector_id": "<string>" }]
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([{merchant_connector_id: '<string>'}])
};
fetch('https://sandbox.hyperswitch.io/routing/default/profile/{profile_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/default/profile/{profile_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'merchant_connector_id' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.hyperswitch.io/routing/default/profile/{profile_id}"
payload := strings.NewReader("[\n {\n \"merchant_connector_id\": \"<string>\"\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.hyperswitch.io/routing/default/profile/{profile_id}")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"merchant_connector_id\": \"<string>\"\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hyperswitch.io/routing/default/profile/{profile_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"merchant_connector_id\": \"<string>\"\n }\n]"
response = http.request(request)
puts response.read_body{
"profile_id": "profile_123",
"connectors": [
{
"connector": "absa_sanlam",
"merchant_connector_id": "<string>"
}
]
}Authorizations
api_keyjwt_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.
Path Parameters
The unique identifier for a profile
Body
application/json
RoutableConnectors are the subset of Connectors that are eligible for payments routing
Available options:
absa_sanlam, authipay, adyenplatform, stripe_billing_test, phonypay, fauxpay, pretendpay, stripe_test, adyen_test, checkout_test, paypal_test, aci, adyen, affirm, airwallex, amazonpay, archipel, authorizedotnet, bankofamerica, barclaycard, billwerk, bitpay, bambora, blackhawknetwork, bamboraapac, bluesnap, calida, boku, braintree, breadpay, cashtocode, celero, chargebee, custombilling, checkbook, checkout, coinbase, coingate, cryptopay, cybersource, cybersourcedecisionmanager, datatrans, deutschebank, digitalvirgo, dlocal, dwolla, ebanx, elavon, envoy, facilitapay, finix, fiserv, fiservemea, fiservcommercehub, fiuu, flexiti, forte, getnet, gigadat, globalpay, globepay, gocardless, hipay, helcim, hyperpg, iatapay, imerchantsolutions, inespay, interpayments, itaubank, jpmorgan, klarna, loonio, mifinity, mollie, moneris, multisafepay, nexinets, nexixpay, nmi, nomupay, noon, nordea, novalnet, nuvei, opennode, paybox, payme, payload, payone, paypal, paysafe, paystack, paytm, payconex, payu, peachpayments, payjustnow, payjustnowinstore, phonepe, placetopay, powertranz, prophetpay, rapyd, razorpay, recurly, redsys, revolv3, riskified, santander, shift4, signifyd, silverflow, square, stax, stripe, stripebilling, tesouro, truelayer, trustly, trustpay, trustpayments, tokenio, tsys, volt, wellsfargo, wise, worldline, worldpay, worldpaymodular, worldpayvantiv, worldpayxml, xendit, zen, zift, plaid, zsl, juspaythreedsserver, ctp_mastercard, ctp_visa, netcetera, cardinal, threedsecureio Response
Successfully updated default config for profile
Default routing configuration associated with a business profile.
This represents the fallback routing connectors configured at the profile level.
Unique identifier of the business profile.
Example:
"profile_123"
Example:
"profile_123"
List of connectors configured as default for this profile.
Example:
[
{
"connector": "stripe",
"merchant_connector_id": "mca_ExbsYfO1xFErhNtwY1PX"
}
]
Show child attributes
Show child attributes