API Reference

Update a gateway

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

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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Gateway ID or code

Body Params
gateway
object
Responses

400

Bad request - invalid parameters

401

Unauthorized - invalid credentials

404

Gateway not found

422

Validation error - invalid gateway configuration

Updated about 2 months ago

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago