Update a gateway

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

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

Path

gateway_idrequired

Body application/json

cURL request

curl --request PUT \
  --url https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/gateways/GATEWAY_ID \
  --header 'Authorization: Basic <base64 of SECRET_KEY:>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const url = 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/gateways/GATEWAY_ID';
const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Basic <base64 of SECRET_KEY:>',
    'Content-Type': 'application/json'
  },
  body: '{}'
};

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

payload = {}
headers = {
    "Authorization": "Basic <base64 of SECRET_KEY:>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/gateways/GATEWAY_ID', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Basic <base64 of SECRET_KEY:>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <base64 of SECRET_KEY:>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

package main

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

func main() {

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

  payload := strings.NewReader("{}")

  req, _ := http.NewRequest("PUT", url, payload)

  req.Header.Add("Authorization", "Basic <base64 of SECRET_KEY:>")
  req.Header.Add("Content-Type", "application/json")

  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/GATEWAY_ID';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer YOUR_ACCESS_TOKEN', 'Content-Type': 'application/json'},
  body: '{}'
};

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

payload = {}
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://app.shuttleglobal.com/c/api/gateways/GATEWAY_ID', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

package main

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

func main() {

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

  payload := strings.NewReader("{}")

  req, _ := http.NewRequest("PUT", url, payload)

  req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")
  req.Header.Add("Content-Type", "application/json")

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

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

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

}

Response

Updated gateway

{
  "gateway": {
    "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
  }
}

PUT

/gateways/{gateway_id}

Updating a gateway is intended to be used in conjunction with Shuttle support.

gateway_id can be either ID or code

Request fields:

status (optional) - update the status to one of ACTIVE, RUNDOWN, ARCHIVE
values - A map of parameters, specific to the gateway, for valid options contact support
tags - An array of strings to store on this objects, you can search objects by tag
metadata - A list of key values pairs to store on a object

Gateway statuses:

ACTIVE - Supports new payments and new payment methods
RUNDOWN - Only support payments on existing payment_methods
ARCHIVE - Does not support new payments or payment_methods, nor will any API requests be made to the gateway in this status

Authorizations

basicAuth
bearerAuth

Parameters

Path Parameters

gateway_id

required

string

The gateway’s ID (gw_...), or its code.

Request Body^required

application/json

object

gateway

object

status

string · enum

Gateway status

Allowed values: ACTIVE RUNDOWN ARCHIVE

values

object

Gateway-specific configuration values

object

tags

Array<string>

Tags for searching and organizing

metadata

object

Custom metadata key-value pairs

object

key

additional properties

any

Responses

200

Updated gateway

application/json

object

gateway

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

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"
}

404

Gateway not found

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.

422

Validation error - invalid gateway configuration

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.

Was this page helpful?

Update a gateway

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

400

401

404

422

Request Body^required