Get instance capabilities

GEThttps://app.shuttleglobal.com/c/api/instances/{instance_id}/capabilities

Language

Credentials

Secret key

Remember 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

instance_idrequired

Query

currency

cURL request

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

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

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/INSTANCE_ID/capabilities', [
  'headers' => [
    'Authorization' => 'Basic <base64 of SECRET_KEY:>',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

url = URI("https://app.shuttleglobal.com/c/api/instances/INSTANCE_ID/capabilities")

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/INSTANCE_ID/capabilities"

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

}

Response

Successful operation

{
  "capabilities": {
    "id": "string",
    "payments_ready": true,
    "currencies": [
      "string"
    ],
    "token_gateways": [
      "string"
    ],
    "payment_method_types": {}
  }
}

GET

/instances/{instance_id}/capabilities

Retrieve the payment capabilities of an instance. This API allows you to determine if the instance is able to process specific types of payments.

Authorizations

basicAuth

Parameters

Path Parameters

instance_id

required

string

The instance’s ID (cl_...), or the instance_key you gave it.

Query Parameters

currency

string

Filter capabilities by currency

Responses

200

Successful operation

application/json

object

capabilities

object

string

The ID of the capabilities record

payments_ready

boolean

Whether the instance is ready to process payments

currencies

Array<string>

List of supported currencies

token_gateways

Array<string>

List of token gateways

payment_method_types

object

Map of payment method types to their supported features

object

key

additional properties

object

features

Array<string>

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

404

Instance 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.

Was this page helpful?