Create a checkout monitor session

POSThttps://app.shuttleglobal.com/c/api/instances/{instance_key}/checkout_monitor

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

Body application/json

cURL request

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

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

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

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

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

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/checkout_monitor', [
  'body' => '{
  "nonce": "THE_NONCE_YOU_PASSED_TO_CHECKOUT"
}',
  '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/checkout_monitor")

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

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

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

  payload := strings.NewReader("{\n  \"nonce\": \"THE_NONCE_YOU_PASSED_TO_CHECKOUT\"\n}")

  req, _ := http.NewRequest("POST", 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))

}

curl --request POST \
  --url https://app.shuttleglobal.com/c/api/checkout_monitor \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "nonce": "THE_NONCE_YOU_PASSED_TO_CHECKOUT"
}'

const url = 'https://app.shuttleglobal.com/c/api/checkout_monitor';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer YOUR_ACCESS_TOKEN', 'Content-Type': 'application/json'},
  body: '{"nonce":"THE_NONCE_YOU_PASSED_TO_CHECKOUT"}'
};

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

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

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

print(response.json())

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.shuttleglobal.com/c/api/checkout_monitor', [
  'body' => '{
  "nonce": "THE_NONCE_YOU_PASSED_TO_CHECKOUT"
}',
  '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/checkout_monitor")

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

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

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

  payload := strings.NewReader("{\n  \"nonce\": \"THE_NONCE_YOU_PASSED_TO_CHECKOUT\"\n}")

  req, _ := http.NewRequest("POST", 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

Created checkout monitor session

{
  "id": "eyJob3N0IjoiYXBwLnNodXR0bGVnbG9iYWwuY29tIiwic2Vzc2lvbiI6IjhiODU0YzY4MWQxNDBiYTEyNjNhMzU2NTQxMzkwYmFjIiwibm9uY2UiOiJUSEVfTk9OQ0VfWU9VX1BBU1NFRF9UT19DSEVDS09VVCJ9"
}

POST

/checkout_monitor

Create a new checkout monitor session. The session ID returned can be used with the Shuttle.checkout_monitor() JavaScript function to receive real-time updates about the checkout process.

The nonce parameter must match the one passed in your checkout options. This ensures that only authorized sessions can monitor the checkout progress.

Authorizations

basicAuth
bearerAuth

Request Body^required

application/json

object

nonce

string

e.g. "THE_NONCE_YOU_PASSED_TO_CHECKOUT"

The nonce passed in the checkout options

Responses

200

Created checkout monitor session

application/json

object

string

Example

eyJob3N0IjoiYXBwLnNodXR0bGVnbG9iYWwuY29tIiwic2Vzc2lvbiI6IjhiODU0YzY4MWQxNDBiYTEyNjNhMzU2NTQxMzkwYmFjIiwibm9uY2UiOiJUSEVfTk9OQ0VfWU9VX1BBU1NFRF9UT19DSEVDS09VVCJ9

The checkout monitor session ID

400

Bad request

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

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

Was this page helpful?

Create a checkout monitor session

Authorizations

Request Bodyrequired

Responses

200

400

401

Request Body^required