Get a deep link

GEThttps://app.shuttleglobal.com/c/api/instances/{instance_key}/deep_links/{deep_link_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

deep_link_idrequired

cURL request

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

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

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

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/deep_links/DEEP_LINK_ID"

  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/deep_links/DEEP_LINK_ID';
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);
}

import requests

url = "https://app.shuttleglobal.com/c/api/deep_links/DEEP_LINK_ID"

headers = {"Authorization": "Bearer YOUR_ACCESS_TOKEN"}

response = requests.get(url, headers=headers)

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.shuttleglobal.com/c/api/deep_links/DEEP_LINK_ID', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

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

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/deep_links/DEEP_LINK_ID"

  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

Deep link details

{
  "deep_link": {
    "type": "gateway-setup",
    "context": {
      "processor": "string",
      "processor_filter": [
        "string"
      ],
      "theme": {},
      "mode": "enquiry",
      "action": "view_account",
      "id": "string",
      "alt_key": "string",
      "menu": "normal",
      "favicon": "string",
      "menu_logo": "string",
      "return_url": "string",
      "features": {
        "refund": "FALSE",
        "manual_capture": "FALSE",
        "account_edit": "FALSE"
      }
    },
    "user": {
      "alt_key": "string",
      "name": "string"
    },
    "session": {
      "teams": [
        "string"
      ]
    },
    "ip_address": "string",
    "expiry_seconds": 900,
    "id": "string"
  }
}

GET

/deep_links/{deep_link_id}

Retrieve details of an existing deep link.

Authorizations

basicAuth
bearerAuth

Parameters

Path Parameters

deep_link_id

required

string

The deep link’s id, as returned when you created it.

Responses

200

Deep link details

application/json

object

deep_link

object

type

required

string · enum

Type of deep link to create:

gateway-setup: Merchant Setup (onboarding)
dashboard: Merchant View

Allowed values: gateway-setup dashboard

context

object

Type-specific parameters that vary based on the deep link type:

For type: gateway-setup (Onboarding)

processor: Limit onboarding to a single processor (e.g., “STRIPE”)
processor_filter: Array of allowed processors (e.g., [“STRIPE”, “SQUARE”])
theme: UI customization options including:
- Font settings (baseFontSize, baseFontFamily)
- Colors (backgroundColor, headerBackground)
- Layout (baseBorderRadius, rowHeight)
- Full theme options documented in UI Components guide

For type: dashboard (Merchant View)

mode: Section to display — “enquiry” or “setup”
action: View to display:
- “view_account”: Show account details
- “view_contract”: Show contract details
- “view_transaction”: Show transaction details
- “view_payment_method”: Show payment method details
- “localisation”: Show localisation settings (requires mode “setup”)
id: ID of object to view (use this OR alt_key)
alt_key: Alternative key of object (use this OR id)
menu: Menu display type:
- “normal”: Standard menu
- “banner”: Banner style menu with logo
- “hidden”: No menu
favicon: URL to PNG favicon when opened in window
menu_logo: URL to PNG logo for banner menu (max 120x20px)
return_url: URL to return to when logo clicked (banner menu)
features: Turn individual Merchant View actions (refunds, captures, account editing, contract amendments) on or off for this session, overriding the defaults set on the application. See Merchant View Options

object

processor

string

For gateway-setup, use onboarding for a single processor only (e.g., “STRIPE”)

processor_filter

Array<string>

For gateway-setup, filter available processors (e.g., [“STRIPE”, “SQUARE”])

theme

object

UI theme customization options including font settings, colors, and layout. See UI Components guide for full list of theme properties.

object

mode

string · enum

Section of the merchant view to display

Allowed values: enquiry setup

action

string · enum

Specific view to display in merchant view

Allowed values: view_account view_contract view_transaction view_payment_method localisation

string

ID of object to view in merchant view (use this OR alt_key)

alt_key

string

Alternative key of object to view (use this OR id)

menu

string · enum

Type of menu to display in merchant view

Allowed values: normal banner hidden

favicon

string

URL to PNG favicon when merchant view opened in window

menu_logo

string

URL to PNG logo for banner menu (max 120x20px recommended)

return_url

string

URL to return to when logo clicked in banner menu

features

object

Example

{
  "refund": "FALSE",
  "manual_capture": "FALSE",
  "account_edit": "FALSE"
}

For merchant view, overrides the Merchant View options set on the application (Developer Portal, Developer tab, Merchant View), for this deep link only.

Each key is an option – account_edit, comments, manual_capture, moto_payment, moto_tokenise, payment_method_edit, recurring, recurring_edit, recurring_edit_in_place, refund, refund_offline – and each value is "TRUE" or "FALSE". An option you omit keeps the application default; an option never set anywhere is enabled. Disabling an option removes the control from the UI entirely.

For what each option does, see Merchant View Options

object

key

additional properties

string · enum

Allowed values: TRUE FALSE

user

object

alt_key

required

string

Your primary key for the logged in user

name

string

Name of the logged in user

session

object

teams

Array<string>

Teams the user belongs to

ip_address

string

IP address of the merchant

expiry_seconds

integer

default 900

Time in seconds this deep link is active

required

string

Deep link ID

401

Unauthorised: the API key is missing or not valid

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

Deep link 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?