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>'
{
  "connections": [
    {
      "id": "<string>",
      "provider": "<string>",
      "mode": "<string>",
      "status": "<string>",
      "capabilities": {},
      "routing_hints": {
        "country_preference": [
          "<string>"
        ],
        "method_bias": {},
        "fallback_only": true
      },
      "labels": [
        "<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
  }
}

Authorizations

X-Reevit-Key
string
header
required

API key for server-to-server authentication

Headers

X-Org-Id
string
required

Organization identifier for multi-tenancy

Query Parameters

label
string

Filter connections that include the specified label (case-insensitive)

provider
string

Filter connections by provider (case-insensitive)

status
string

Filter connections by status (active or inactive)

limit
integer
default:50

Maximum number of connections to return

Required range: 1 <= x <= 200
offset
integer
default:0

Number of connections to skip before starting to collect the result set

Required range: x >= 0

Response

OK

connections
object[]
pagination
object