List PSP connections for the calling org (BYOK)
curl --request GET \
--url http://localhost:8081/v1/connections \
--header 'X-Org-Id: <x-org-id>' \
--header 'X-Reevit-Key: <api-key>'import requests
url = "http://localhost:8081/v1/connections"
headers = {
"X-Org-Id": "<x-org-id>",
"X-Reevit-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Org-Id': '<x-org-id>', 'X-Reevit-Key': '<api-key>'}
};
fetch('http://localhost:8081/v1/connections', 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 => "8081",
CURLOPT_URL => "http://localhost:8081/v1/connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Org-Id: <x-org-id>",
"X-Reevit-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 := "http://localhost:8081/v1/connections"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Org-Id", "<x-org-id>")
req.Header.Add("X-Reevit-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("http://localhost:8081/v1/connections")
.header("X-Org-Id", "<x-org-id>")
.header("X-Reevit-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8081/v1/connections")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["X-Org-Id"] = '<x-org-id>'
request["X-Reevit-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"connections": [
{
"id": "<string>",
"provider": "<string>",
"mode": "<string>",
"status": "<string>",
"capabilities": {},
"routing_hints": {
"country_preference": [
"<string>"
],
"method_bias": {},
"fallback_only": true
},
"labels": [
"<string>"
],
"workflow_id": "<string>",
"fee_structure": {
"percentage": 123,
"fixed": 123,
"per_method": {},
"per_currency": {}
},
"total_calls": 123,
"successful_calls": 123,
"failed_calls": 123,
"total_latency_ms": 123,
"last_success_at": "2023-11-07T05:31:56Z",
"last_failure_at": "2023-11-07T05:31:56Z",
"health_score": 123,
"health_status": "<string>",
"last_validated_at": "2023-11-07T05:31:56Z",
"last_validation_status": "<string>",
"last_validation_error": "<string>",
"validation_failures": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"total": 123,
"limit": 123,
"offset": 123
}
}{
"error": "invalid_request",
"code": "email_required",
"message": "email is required",
"details": {
"metric": "workflow_executions",
"used": "2000",
"limit": "2000",
"reset": "2025-01-01T00:00:00Z"
}
}{
"error": "invalid_request",
"code": "email_required",
"message": "email is required",
"details": {
"metric": "workflow_executions",
"used": "2000",
"limit": "2000",
"reset": "2025-01-01T00:00:00Z"
}
}Connections
List PSP connections for the calling org (BYOK)
GET
/
v1
/
connections
List PSP connections for the calling org (BYOK)
curl --request GET \
--url http://localhost:8081/v1/connections \
--header 'X-Org-Id: <x-org-id>' \
--header 'X-Reevit-Key: <api-key>'import requests
url = "http://localhost:8081/v1/connections"
headers = {
"X-Org-Id": "<x-org-id>",
"X-Reevit-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Org-Id': '<x-org-id>', 'X-Reevit-Key': '<api-key>'}
};
fetch('http://localhost:8081/v1/connections', 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 => "8081",
CURLOPT_URL => "http://localhost:8081/v1/connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Org-Id: <x-org-id>",
"X-Reevit-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 := "http://localhost:8081/v1/connections"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Org-Id", "<x-org-id>")
req.Header.Add("X-Reevit-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("http://localhost:8081/v1/connections")
.header("X-Org-Id", "<x-org-id>")
.header("X-Reevit-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8081/v1/connections")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["X-Org-Id"] = '<x-org-id>'
request["X-Reevit-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"connections": [
{
"id": "<string>",
"provider": "<string>",
"mode": "<string>",
"status": "<string>",
"capabilities": {},
"routing_hints": {
"country_preference": [
"<string>"
],
"method_bias": {},
"fallback_only": true
},
"labels": [
"<string>"
],
"workflow_id": "<string>",
"fee_structure": {
"percentage": 123,
"fixed": 123,
"per_method": {},
"per_currency": {}
},
"total_calls": 123,
"successful_calls": 123,
"failed_calls": 123,
"total_latency_ms": 123,
"last_success_at": "2023-11-07T05:31:56Z",
"last_failure_at": "2023-11-07T05:31:56Z",
"health_score": 123,
"health_status": "<string>",
"last_validated_at": "2023-11-07T05:31:56Z",
"last_validation_status": "<string>",
"last_validation_error": "<string>",
"validation_failures": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"total": 123,
"limit": 123,
"offset": 123
}
}{
"error": "invalid_request",
"code": "email_required",
"message": "email is required",
"details": {
"metric": "workflow_executions",
"used": "2000",
"limit": "2000",
"reset": "2025-01-01T00:00:00Z"
}
}{
"error": "invalid_request",
"code": "email_required",
"message": "email is required",
"details": {
"metric": "workflow_executions",
"used": "2000",
"limit": "2000",
"reset": "2025-01-01T00:00:00Z"
}
}Authorizations
API key for server-to-server authentication
Headers
Organization identifier for multi-tenancy
Query Parameters
Filter connections that include the specified label (case-insensitive)
Filter connections by provider (case-insensitive)
Filter connections by status (active or inactive)
Filter connections by test or live mode
Available options:
sandbox, live Maximum number of connections to return
Required range:
1 <= x <= 200Number of connections to skip before starting to collect the result set
Required range:
x >= 0⌘I

