List legal entity routes

GEThttps://app.shuttleglobal.com/c/api/instances/{instance_key}/legal_entity_routes

Language

Credentials

Secret key

Instance keyRemember on this device

Kept in this browser tab unless you tick Remember; don't on a shared computer. Use keys from a sandbox account to test without moving money.

Parameters

Query

criteriaorderexpandlimitoffset

cURL request

curl --request GET \
  --url https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/legal_entity_routes \
  --header 'Authorization: Basic <base64 of SECRET_KEY:>'

const url = 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/legal_entity_routes';
const options = {method: 'GET', headers: {Authorization: 'Basic <base64 of SECRET_KEY:>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/legal_entity_routes"

headers = {"Authorization": "Basic <base64 of SECRET_KEY:>"}

response = requests.get(url, headers=headers)

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/legal_entity_routes', [
  'headers' => [
    'Authorization' => 'Basic <base64 of SECRET_KEY:>',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

url = URI("https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/legal_entity_routes")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <base64 of SECRET_KEY:>'

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

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/legal_entity_routes"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Basic <base64 of SECRET_KEY:>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://app.shuttleglobal.com/c/api/legal_entity_routes';
const options = {method: 'GET', headers: {Authorization: 'Bearer YOUR_ACCESS_TOKEN'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://app.shuttleglobal.com/c/api/legal_entity_routes"

headers = {"Authorization": "Bearer YOUR_ACCESS_TOKEN"}

response = requests.get(url, headers=headers)

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.shuttleglobal.com/c/api/legal_entity_routes', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

url = URI("https://app.shuttleglobal.com/c/api/legal_entity_routes")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'

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

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://app.shuttleglobal.com/c/api/legal_entity_routes"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Response

List of legal entity routes

{
  "legal_entity_routes": [
    {
      "id": "string",
      "legal_entity": "string",
      "gateway": "string",
      "currencies": [
        "string"
      ],
      "payment_method_types": [
        "string"
      ],
      "metadata": {},
      "rules": {},
      "workflows": [
        {}
      ],
      "status": "LINKED",
      "created": "2026-01-01T12:00:00Z",
      "created_session": "string",
      "updated": "2026-01-01T12:00:00Z",
      "updated_session": "string",
      "v": 0
    }
  ],
  "meta": {
    "limit": 0,
    "offset": 0,
    "total": 0
  }
}

GET

/legal_entity_routes

Search and list legal entity route objects with pagination support.

Authorizations

basicAuth
bearerAuth

Parameters

Query Parameters

criteria

string

Search criteria for filtering routes. Available fields:

id
created
gateway
legal_entity
legal_entity_code
status
updated

Examples:

status=ACTIVE
legal_entity=le_12345_10000
gateway=gw_12345_10000

order

string

Sort order for results. Supports any field that criteria supports. Defaults to created:desc if not specified. Append :desc for descending order.

expand

string

Fields to expand into full objects. Separate multiple fields with commas.

Available fields:

created_session (session object)
gateway (gateway object)
legal_entity (legal entity object)
updated_session (session object)

limit

integer

Number of records to return: 20 if not set, at most 1000.

offset

integer

Number of records to skip before the first one returned. offset + limit can’t exceed 5000; to read further, page by a field such as created instead. See Paging through results.

Responses

200

List of legal entity routes

application/json

object

legal_entity_routes

Array<object>

A mapping between a legal entity and a payment gateway

object

string

Unique identifier for the route

Pattern /^lr_[0-9]+_[0-9]+$/

legal_entity

string

Legal entity ID

gateway

string

Gateway ID

currencies

Array<string>

Array of ISO currency codes this route supports

payment_method_types

Array<string>

Array of payment method types this route supports (e.g., VISA, MASTERCARD)

metadata

object

Custom key-value pairs

object

key

additional properties

any

rules

object

Payment routing rules per source type

object

ECOMMERCE

object

Rules for ecommerce payments

object

MOTO

object

Rules for MOTO payments

object

POS

object

Rules for POS payments

object

RECURRING

object

Rules for recurring payments

object

workflows

Array<object>

Workflow configurations attached to this route

object

status

string · enum

Status of the route:

LINKED - active but not yet used
ACTIVE - in use
INACTIVE - no longer in use, no payments may utilise this connection
RUNDOWN - no longer in use for new card details, saved cards may continue to be used

Allowed values: LINKED ACTIVE INACTIVE RUNDOWN

created

string · date-time

When the route was created

created_session

string

Session that created this route

updated

string · date-time

When the route was last updated

updated_session

string

Session that last updated this route

integer

Version of the record

meta

object

limit

integer

offset

integer

total

integer

400

Bad request

application/json

Every error has a code and a message. Some add more fields alongside them, with detail about the error.

object

code

string

The error code, for example VALIDATION_ERROR, INVALID, INVALID_REQUEST, UNAUTHORIZED, FORBIDDEN or NOT_FOUND. Program against this, not the message.

message

string

What went wrong, in words, for logs and support.

401

Unauthorised: the API key is missing or not valid

application/json

Every error has a code and a message. Some add more fields alongside them, with detail about the error.

object

code

string

The error code, for example VALIDATION_ERROR, INVALID, INVALID_REQUEST, UNAUTHORIZED, FORBIDDEN or NOT_FOUND. Program against this, not the message.

message

string

What went wrong, in words, for logs and support.

Example

{
  "code": "UNAUTHORIZED",
  "message": "Unauthorised"
}

Was this page helpful?