List processors

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

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.

cURL request

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

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

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

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

  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/processors';
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/processors', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

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

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

  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 processors

{
  "processors": [
    {
      "id": "STRIPE",
      "name": "Stripe",
      "category": "RECOMMENDED",
      "visible": true,
      "oauth": true,
      "oauth_url": "string",
      "help": "string",
      "website": "string",
      "logo_url": "string",
      "instructions": "string",
      "onboarding_js": "string",
      "countries": [
        "US",
        "GB",
        "AU"
      ],
      "payment_method_types": [
        "VISA",
        "MASTERCARD",
        "AMEX"
      ],
      "priority": 0,
      "created": "2026-01-01T12:00:00Z",
      "updated": "2026-01-01T12:00:00Z"
    }
  ],
  "meta": {
    "total": 0
  }
}

GET

/processors

Returns a list of payment processors available to the application. Filter for visible: true to get processors available for new connections.

Authorizations

basicAuth
bearerAuth

Responses

200

List of processors

application/json

object

processors

Array<object>

A payment processor available for gateway connections

object

string

e.g. "STRIPE"

Processor identifier (e.g., STRIPE, ADYEN, SANDBOX)

name

string

e.g. "Stripe"

Display name of the processor

category

string · enum

e.g. "RECOMMENDED"

Processor category. Categories can change as processors are promoted or demoted

Allowed values: RECOMMENDED STD BETA

visible

boolean

e.g. true

Whether the processor is available for new connections

oauth

boolean

e.g. true

Whether the connection requires an OAuth flow

oauth_url

string

URL to forward the user to complete the OAuth connection process. It points at Shuttle, which handles the processor’s own redirect and then sends the user on to your URLs. Replace its placeholders before use: #SUCCESSURL# and #CANCELURL# with your URL-encoded success and cancel URLs, and #NONCE# with a value unique to this attempt. On success, oauth_data is appended to your success URL (?oauth_data=..., or &oauth_data=... if it already has a query string). Pass it as oauth_data to Create a gateway within an hour to create the connection.

help

string

URL to help documentation for this processor

website

string

Processor company website

logo_url

string

URL to the processor logo (transparent background, for light backgrounds)

instructions

string

Markdown snippet explaining how to configure the processor

onboarding_js

string

Base64-encoded onboarding JavaScript

countries

Array<string>

e.g. [ "US", "GB", "AU"]

ISO country codes where this processor can acquire merchants

payment_method_types

Array<string>

e.g. [ "VISA", "MASTERCARD", "AMEX"]

Payment method types supported by this processor

priority

integer

Display priority order

created

string · date-time

When the processor was added

updated

string · date-time

When the processor was last updated

meta

object

total

integer

401

Unauthorized

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?