List gateways

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

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/gateways \
  --header 'Authorization: Basic <base64 of SECRET_KEY:>'

const url = 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/gateways';
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/gateways"

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/gateways', [
  '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/gateways")

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/gateways"

  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/gateways';
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);
}

<?php

$client = new \GuzzleHttp\Client();

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

echo $response->getBody();

require 'uri'
require 'net/http'

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

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/gateways"

  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 gateways

{
  "gateways": [
    {
      "id": "string",
      "name": "string",
      "code": "string",
      "division": "string",
      "status": "CREATED",
      "status_reason": "string",
      "processor": "string",
      "processor_name": "string",
      "processor_account_name": "string",
      "gateway_group": "string",
      "currencies": [
        "string"
      ],
      "payment_method_types": {},
      "payment_method_types_moto": {},
      "metadata": {},
      "tags": [
        "string"
      ],
      "features": {},
      "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

/gateways

List and search gateways for an instance.

Available search fields:

id: Gateway ID
code: Your gateway reference
created: Creation timestamp
division: Division ID
processor: Processor type (e.g., STRIPE)
status: Gateway status
updated: Last update timestamp

Expandable fields:

authenticate_js: JavaScript for express checkout
checkout_js: JavaScript for normal checkout
credit_message_js: JavaScript for credit messages
created_session: Creation session details
processor: Processor details
updated_session: Update session details

Authorizations

basicAuth
bearerAuth

Parameters

Query Parameters

criteria

string

Search criteria for filtering gateways. Available fields:

id
code
created
division
processor
status
updated

Examples:

status=ACTIVE
processor=STRIPE

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:

authenticate_js (JavaScript for express checkout)
checkout_js (JavaScript for normal checkout)
credit_message_js (JavaScript for credit messages)
created_session (session object)
processor (processor details)
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 gateways

application/json

object

gateways

Array<object>

object

string

Shuttle’s ID for the gateway

name

string

Display name for the gateway

code

string

Your ID for the gateway (or auto-generated)

division

string

Division ID (enterprise)

status

string · enum

Gateway status

Allowed values: CREATED LINKED ACTIVE ARCHIVE SETUP INACTIVE RUNDOWN

status_reason

string

Reason for current status (e.g., access revoked)

processor

string

Payment processor type (e.g., STRIPE)

processor_name

string

Display name of the processor

processor_account_name

string

Name of connected merchant account

gateway_group

string

Group ID for sharing payment tokens

currencies

Array<string>

Supported payment currencies

payment_method_types

object

Supported ecommerce payment methods

object

key

additional properties

object

features

Array<string> · enum

Allowed values: AUTHORISE AUTHORISE_AND_SAVE_TOKEN AUTHORISE_ON_SAVED_TOKEN PAYMENT COMPLETE_AUTHORISATION PAYMENT_AND_SAVE_TOKEN PAYMENT_ON_SAVED_TOKEN SAVE_CARD FULL_REFUND PARTIAL_REFUND MULTI_REFUND CAPTURE VOID RAW_PAN

payment_method_types_moto

object

Supported MOTO payment methods

object

key

additional properties

object

features

Array<string> · enum

metadata

object

Custom key-value pairs

object

key

additional properties

any

tags

Array<string>

Tags/references

features

object

Feature flags for the gateway

object

key

additional properties

any

created

string · date-time

Creation timestamp

created_session

string

Session that created this gateway

updated

string · date-time

Last update timestamp

updated_session

string

Session that last updated this gateway

integer

Record version

meta

object

limit

integer

offset

integer

total

integer

400

Bad request - invalid parameters

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

Unauthorized - invalid credentials

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?