Configure gateway routing percentages
curl --request PUT \
--url http://localhost:7701/api/v1/company/gateways/routing \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'x-client-id: <x-client-id>' \
--data '
{
"gateways": [
{
"gateway_slug": "erede",
"percentage": 30
}
],
"payment_method": "card"
}
'import requests
url = "http://localhost:7701/api/v1/company/gateways/routing"
payload = {
"gateways": [
{
"gateway_slug": "erede",
"percentage": 30
}
],
"payment_method": "card"
}
headers = {
"x-client-id": "<x-client-id>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-client-id': '<x-client-id>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({gateways: [{gateway_slug: 'erede', percentage: 30}], payment_method: 'card'})
};
fetch('http://localhost:7701/api/v1/company/gateways/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_PORT => "7701",
CURLOPT_URL => "http://localhost:7701/api/v1/company/gateways/routing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'gateways' => [
[
'gateway_slug' => 'erede',
'percentage' => 30
]
],
'payment_method' => 'card'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>",
"x-client-id: <x-client-id>"
],
]);
$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:7701/api/v1/company/gateways/routing"
payload := strings.NewReader("{\n \"gateways\": [\n {\n \"gateway_slug\": \"erede\",\n \"percentage\": 30\n }\n ],\n \"payment_method\": \"card\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-client-id", "<x-client-id>")
req.Header.Add("X-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.put("http://localhost:7701/api/v1/company/gateways/routing")
.header("x-client-id", "<x-client-id>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"gateways\": [\n {\n \"gateway_slug\": \"erede\",\n \"percentage\": 30\n }\n ],\n \"payment_method\": \"card\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:7701/api/v1/company/gateways/routing")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["x-client-id"] = '<x-client-id>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"gateways\": [\n {\n \"gateway_slug\": \"erede\",\n \"percentage\": 30\n }\n ],\n \"payment_method\": \"card\"\n}"
response = http.request(request)
puts response.read_bodyCompany Gateways
Configure gateway routing percentages
Sets percentage-based routing for the company gateways. Optionally scoped to a payment method (card or pix). Omit payment_method to set a default that applies to all methods. Percentages must sum to 100 or all be 0 to clear routing.
PUT
/
api
/
v1
/
company
/
gateways
/
routing
Configure gateway routing percentages
curl --request PUT \
--url http://localhost:7701/api/v1/company/gateways/routing \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'x-client-id: <x-client-id>' \
--data '
{
"gateways": [
{
"gateway_slug": "erede",
"percentage": 30
}
],
"payment_method": "card"
}
'import requests
url = "http://localhost:7701/api/v1/company/gateways/routing"
payload = {
"gateways": [
{
"gateway_slug": "erede",
"percentage": 30
}
],
"payment_method": "card"
}
headers = {
"x-client-id": "<x-client-id>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-client-id': '<x-client-id>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({gateways: [{gateway_slug: 'erede', percentage: 30}], payment_method: 'card'})
};
fetch('http://localhost:7701/api/v1/company/gateways/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_PORT => "7701",
CURLOPT_URL => "http://localhost:7701/api/v1/company/gateways/routing",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'gateways' => [
[
'gateway_slug' => 'erede',
'percentage' => 30
]
],
'payment_method' => 'card'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>",
"x-client-id: <x-client-id>"
],
]);
$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:7701/api/v1/company/gateways/routing"
payload := strings.NewReader("{\n \"gateways\": [\n {\n \"gateway_slug\": \"erede\",\n \"percentage\": 30\n }\n ],\n \"payment_method\": \"card\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-client-id", "<x-client-id>")
req.Header.Add("X-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.put("http://localhost:7701/api/v1/company/gateways/routing")
.header("x-client-id", "<x-client-id>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"gateways\": [\n {\n \"gateway_slug\": \"erede\",\n \"percentage\": 30\n }\n ],\n \"payment_method\": \"card\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:7701/api/v1/company/gateways/routing")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["x-client-id"] = '<x-client-id>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"gateways\": [\n {\n \"gateway_slug\": \"erede\",\n \"percentage\": 30\n }\n ],\n \"payment_method\": \"card\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Company API key. Send in the X-API-Key header.
Headers
Client identifier for the company in the request.
Example:
"client_abc123"
Body
application/json
Response
Routing percentages updated