Activate Routing Rule

Activate a routing rule by ID for a merchant. Only one rule can be active at a time — activating a new rule deactivates the previous one.

POST /routing/activate

Activate routing rule

cURL

curl --request POST \
  --url http://localhost:8080/routing/activate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "created_by": "test_merchant",
  "routing_algorithm_id": "rule_abc123"
}
'

import requests

url = "http://localhost:8080/routing/activate"

payload = {
    "created_by": "test_merchant",
    "routing_algorithm_id": "rule_abc123"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({created_by: 'test_merchant', routing_algorithm_id: 'rule_abc123'})
};

fetch('http://localhost:8080/routing/activate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://localhost:8080/routing/activate",
  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([
    'created_by' => 'test_merchant',
    'routing_algorithm_id' => 'rule_abc123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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 := "http://localhost:8080/routing/activate"

	payload := strings.NewReader("{\n  \"created_by\": \"test_merchant\",\n  \"routing_algorithm_id\": \"rule_abc123\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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("http://localhost:8080/routing/activate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"created_by\": \"test_merchant\",\n  \"routing_algorithm_id\": \"rule_abc123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8080/routing/activate")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"created_by\": \"test_merchant\",\n  \"routing_algorithm_id\": \"rule_abc123\"\n}"

response = http.request(request)
puts response.read_body

Authorizations

BearerAuthApiKeyAuth

Authorization · string · header · required

JWT token obtained from /auth/login

Body

application/json

created_by · string · required

Example:

"test_merchant"

routing_algorithm_id · string · required

Example:

"rule_abc123"

Response

200

Rule activated. The response body is empty.