Routing - Evaluate
curl --request POST \
--url https://sandbox.birrpay.io/routing/evaluate \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"paymentInfo": {
"paymentId": "<string>",
"amount": 123,
"paymentType": "<string>",
"paymentMethodType": "<string>",
"metadata": "<string>",
"cardIsin": "<string>"
},
"merchantId": "<string>",
"eligibleGatewayList": [
"<string>"
],
"eliminationEnabled": true
}
'import requests
url = "https://sandbox.birrpay.io/routing/evaluate"
payload = {
"paymentInfo": {
"paymentId": "<string>",
"amount": 123,
"paymentType": "<string>",
"paymentMethodType": "<string>",
"metadata": "<string>",
"cardIsin": "<string>"
},
"merchantId": "<string>",
"eligibleGatewayList": ["<string>"],
"eliminationEnabled": True
}
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({
paymentInfo: {
paymentId: '<string>',
amount: 123,
paymentType: '<string>',
paymentMethodType: '<string>',
metadata: '<string>',
cardIsin: '<string>'
},
merchantId: '<string>',
eligibleGatewayList: ['<string>'],
eliminationEnabled: true
})
};
fetch('https://sandbox.birrpay.io/routing/evaluate', 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.birrpay.io/routing/evaluate",
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([
'paymentInfo' => [
'paymentId' => '<string>',
'amount' => 123,
'paymentType' => '<string>',
'paymentMethodType' => '<string>',
'metadata' => '<string>',
'cardIsin' => '<string>'
],
'merchantId' => '<string>',
'eligibleGatewayList' => [
'<string>'
],
'eliminationEnabled' => true
]),
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.birrpay.io/routing/evaluate"
payload := strings.NewReader("{\n \"paymentInfo\": {\n \"paymentId\": \"<string>\",\n \"amount\": 123,\n \"paymentType\": \"<string>\",\n \"paymentMethodType\": \"<string>\",\n \"metadata\": \"<string>\",\n \"cardIsin\": \"<string>\"\n },\n \"merchantId\": \"<string>\",\n \"eligibleGatewayList\": [\n \"<string>\"\n ],\n \"eliminationEnabled\": true\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.birrpay.io/routing/evaluate")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paymentInfo\": {\n \"paymentId\": \"<string>\",\n \"amount\": 123,\n \"paymentType\": \"<string>\",\n \"paymentMethodType\": \"<string>\",\n \"metadata\": \"<string>\",\n \"cardIsin\": \"<string>\"\n },\n \"merchantId\": \"<string>\",\n \"eligibleGatewayList\": [\n \"<string>\"\n ],\n \"eliminationEnabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.birrpay.io/routing/evaluate")
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 \"paymentInfo\": {\n \"paymentId\": \"<string>\",\n \"amount\": 123,\n \"paymentType\": \"<string>\",\n \"paymentMethodType\": \"<string>\",\n \"metadata\": \"<string>\",\n \"cardIsin\": \"<string>\"\n },\n \"merchantId\": \"<string>\",\n \"eligibleGatewayList\": [\n \"<string>\"\n ],\n \"eliminationEnabled\": true\n}"
response = http.request(request)
puts response.read_body{
"decided_gateway": "<string>",
"gateway_priority_map": null,
"filter_wise_gateways": null,
"priority_logic_tag": "<string>",
"routing_approach": "<string>",
"gateway_before_evaluation": "<string>",
"priority_logic_output": {
"isEnforcement": true,
"gws": [
"<string>"
],
"priorityLogicTag": "<string>",
"gatewayReferenceIds": {},
"primaryLogic": {
"name": "<string>",
"status": "<string>",
"failure_reason": "<string>"
},
"fallbackLogic": {
"name": "<string>",
"status": "<string>",
"failure_reason": "<string>"
}
},
"reset_approach": "<string>",
"routing_dimension": "<string>",
"routing_dimension_level": "<string>",
"is_scheduled_outage": true,
"is_dynamic_mga_enabled": true,
"gateway_mga_id_map": null
}Routing
Routing - Evaluate
Evaluate routing rules
POST
/
routing
/
evaluate
Routing - Evaluate
curl --request POST \
--url https://sandbox.birrpay.io/routing/evaluate \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"paymentInfo": {
"paymentId": "<string>",
"amount": 123,
"paymentType": "<string>",
"paymentMethodType": "<string>",
"metadata": "<string>",
"cardIsin": "<string>"
},
"merchantId": "<string>",
"eligibleGatewayList": [
"<string>"
],
"eliminationEnabled": true
}
'import requests
url = "https://sandbox.birrpay.io/routing/evaluate"
payload = {
"paymentInfo": {
"paymentId": "<string>",
"amount": 123,
"paymentType": "<string>",
"paymentMethodType": "<string>",
"metadata": "<string>",
"cardIsin": "<string>"
},
"merchantId": "<string>",
"eligibleGatewayList": ["<string>"],
"eliminationEnabled": True
}
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({
paymentInfo: {
paymentId: '<string>',
amount: 123,
paymentType: '<string>',
paymentMethodType: '<string>',
metadata: '<string>',
cardIsin: '<string>'
},
merchantId: '<string>',
eligibleGatewayList: ['<string>'],
eliminationEnabled: true
})
};
fetch('https://sandbox.birrpay.io/routing/evaluate', 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.birrpay.io/routing/evaluate",
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([
'paymentInfo' => [
'paymentId' => '<string>',
'amount' => 123,
'paymentType' => '<string>',
'paymentMethodType' => '<string>',
'metadata' => '<string>',
'cardIsin' => '<string>'
],
'merchantId' => '<string>',
'eligibleGatewayList' => [
'<string>'
],
'eliminationEnabled' => true
]),
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.birrpay.io/routing/evaluate"
payload := strings.NewReader("{\n \"paymentInfo\": {\n \"paymentId\": \"<string>\",\n \"amount\": 123,\n \"paymentType\": \"<string>\",\n \"paymentMethodType\": \"<string>\",\n \"metadata\": \"<string>\",\n \"cardIsin\": \"<string>\"\n },\n \"merchantId\": \"<string>\",\n \"eligibleGatewayList\": [\n \"<string>\"\n ],\n \"eliminationEnabled\": true\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.birrpay.io/routing/evaluate")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paymentInfo\": {\n \"paymentId\": \"<string>\",\n \"amount\": 123,\n \"paymentType\": \"<string>\",\n \"paymentMethodType\": \"<string>\",\n \"metadata\": \"<string>\",\n \"cardIsin\": \"<string>\"\n },\n \"merchantId\": \"<string>\",\n \"eligibleGatewayList\": [\n \"<string>\"\n ],\n \"eliminationEnabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.birrpay.io/routing/evaluate")
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 \"paymentInfo\": {\n \"paymentId\": \"<string>\",\n \"amount\": 123,\n \"paymentType\": \"<string>\",\n \"paymentMethodType\": \"<string>\",\n \"metadata\": \"<string>\",\n \"cardIsin\": \"<string>\"\n },\n \"merchantId\": \"<string>\",\n \"eligibleGatewayList\": [\n \"<string>\"\n ],\n \"eliminationEnabled\": true\n}"
response = http.request(request)
puts response.read_body{
"decided_gateway": "<string>",
"gateway_priority_map": null,
"filter_wise_gateways": null,
"priority_logic_tag": "<string>",
"routing_approach": "<string>",
"gateway_before_evaluation": "<string>",
"priority_logic_output": {
"isEnforcement": true,
"gws": [
"<string>"
],
"priorityLogicTag": "<string>",
"gatewayReferenceIds": {},
"primaryLogic": {
"name": "<string>",
"status": "<string>",
"failure_reason": "<string>"
},
"fallbackLogic": {
"name": "<string>",
"status": "<string>",
"failure_reason": "<string>"
}
},
"reset_approach": "<string>",
"routing_dimension": "<string>",
"routing_dimension_level": "<string>",
"is_scheduled_outage": true,
"is_dynamic_mga_enabled": true,
"gateway_mga_id_map": null
}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.
Body
application/json
Response
Routing rules evaluated successfully
Show child attributes
Show child attributes
⌘I