API Reference

List gateways

get
https://app.shuttleglobal.com/c/api/instances/{instance_key}/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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Search criteria for filtering gateways. Available fields:

  • id
  • code
  • created
  • division
  • processor
  • status
  • updated

Examples:

  • status=ACTIVE
  • processor=STRIPE
string

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

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)
integer

Maximum records to return

integer

Record offset

Responses

400

Bad request - invalid parameters

401

Unauthorized - invalid credentials

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