List transactions

GEThttps://app.shuttleglobal.com/c/api/instances/{instance_key}/transactions

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

Query

criteriaorderexpandlimitoffset

cURL request

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

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

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

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

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

<?php

$client = new \GuzzleHttp\Client();

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

echo $response->getBody();

require 'uri'
require 'net/http'

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

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

  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

Successful response

{
  "transactions": [
    {
      "account": "string",
      "action": "PAYMENT",
      "alt_key": "string",
      "amount": "string",
      "authorisation_code": "string",
      "authorised": "string",
      "balance": "string",
      "browser_ip_address": "string",
      "browser_accept_header": "string",
      "browser_javascript": true,
      "browser_locale": "string",
      "browser_user_agent": "string",
      "browser_size": "string",
      "browser_java_enabled": true,
      "browser_color_depth": "string",
      "browser_timezone": "string",
      "captures": [
        "string"
      ],
      "captured": "string",
      "channel": "string",
      "contract": "string",
      "created": "2026-01-01T12:00:00Z",
      "created_session": "string",
      "currency": "string",
      "description": "string",
      "designation": "string",
      "division": "string",
      "expires": "2026-01-01T12:00:00Z",
      "gateway": "string",
      "gateway_message": "string",
      "gateway_metadata": {},
      "gateway_reference": "string",
      "gateway_status": "string",
      "gateway_view_transaction": "string",
      "id": "string",
      "initiated": "2026-01-01T12:00:00Z",
      "initiative": "string",
      "legal_entity": "string",
      "next_attempt": "string",
      "metadata": {},
      "parts": [
        "string"
      ],
      "payment_method": "string",
      "payment_method_used_token": true,
      "processed": "2026-01-01T12:00:00Z",
      "redirect_url": "string",
      "reason": "string",
      "reference": "string",
      "refunds": [
        "string"
      ],
      "refund": "string",
      "refunded": "string",
      "resolved": "2026-01-01T12:00:00Z",
      "settle_currency": "string",
      "settle_fee_amount": "string",
      "settle_gross_amount": "string",
      "settle_net_amount": "string",
      "source": "ECOMMERCE",
      "source_transaction": "string",
      "status": "SUCCESS",
      "sub_status": "NO_ACTION_REQUIRED",
      "sub_status_reason": "follow_bank_transfer_instructions",
      "target_date": "2026-01-01T12:00:00Z",
      "updated": "2026-01-01T12:00:00Z",
      "updated_session": "string",
      "voided": "string",
      "voids": [
        "string"
      ],
      "v": 0,
      "workflows": [
        "string"
      ],
      "workflow_status": "OK"
    }
  ],
  "meta": {
    "limit": 0,
    "offset": 0,
    "total": 0
  }
}

GET

/transactions

This request performs a simple search against transaction objects.

Available fields for criteria and order: account, action, alt_key, amount, contract, created, currency, gateway, gateway_reference, id, initiated, payment_method, processed, reference, source, source_transaction, status, sub_status, updated

Authorizations

basicAuth
bearerAuth

Parameters

Query Parameters

criteria

string

Search criteria for filtering transactions. Available fields: id, account, action, alt_key, amount, contract, created, currency, gateway, gateway_reference, gateway_status, initiated, payment_method, processed, reference, source, source_transaction, status, sub_status, updated

Examples:

status=SUCCESS
account=acc_12345_67890
action=PAYMENT
created<>2024-01-01;2024-12-31
gateway_reference=ch_1234567890

order

string

Sort order for results. Supports any field that criteria supports. Defaults to created:desc if not specified. Append :desc for descending order. Separate multiple order fields with commas.

Examples:

order=processed:desc
order=amount:desc
order=status,created:desc

expand

string

Fields to expand into full objects. Separate multiple fields with commas.

Available fields:

account (account object)
captures (capture objects)
contract (contract object)
created_session (session object)
gateway (gateway object)
parts (transaction part objects)
payment_method (payment method object)
refunds (refund objects)
source_transaction (transaction object)
updated_session (session object)

Example: expand=account,contract,payment_method

limit

integer

Number of records to return: 20 if not set, at most 1000.

offset

integer

Number of records to skip before the first one returned. offset + limit can’t exceed 5000; to read further, page by a field such as created instead. See Paging through results.

Responses

200

Successful response

application/json

object

transactions

Array<object>

object

account

string

The person the transaction was for

action

string · enum

The type of transaction

Allowed values: PAYMENT REFUND AUTH CAPTURE VOID

alt_key

string

Your reference for the transaction

amount

string

The amount of the transaction

authorisation_code

string

The authorisation code returned from the gateway

authorised

string

The amount authorised (and uncaptured) if an AUTH

balance

string

The payment amount less any refunds

browser_ip_address

string

The browser’s IP address

browser_accept_header

string

The browser’s accept header

browser_javascript

boolean

If the browser has javascript enabled

browser_locale

string

The browser’s locale

browser_user_agent

string

The browser’s user agent

browser_size

string

The browser’s screen dimension

browser_java_enabled

boolean

If the browser has java enabled

browser_color_depth

string

The browser’s color depth

browser_timezone

string

The browser’s timezone

captures

Array<string>

The IDs of any related captures

captured

string

The amount of the authorisation that has been captured if an AUTH

channel

string

(enterprise) The channel the transaction was processed via

contract

string

The contract this transaction belongs to

created

string · date-time

When the transaction was created

created_session

string

The session the object was created by

currency

string

The currency in ISO format

description

string

The order description

designation

string

(enterprise) The designation the transaction was processed via

division

string

(enterprise) The division from which the payment was instructed

expires

string · date-time

If action = AUTH the date the authorisation expires (where known)

gateway

string

The gateway the transaction was processed via

gateway_message

string

The status message returned by the gateway

gateway_metadata

object

Any metadata returned by the gateway

object

gateway_reference

string

The gateway identifier for the transaction

gateway_status

string

The category or error message received from the gateway

gateway_view_transaction

string

For gateways that support it, a link to the processor’s dashboard

string

The ID of the transaction

initiated

string · date-time

When the transaction was instructed by the user

initiative

string

(enterprise) The initiative the transaction was for

legal_entity

string

(enterprise) The legal entity the transaction was processed via

next_attempt

string

The next payment attempt if a declined payment that was retried

metadata

object

Custom key-value pairs stored on the transaction

object

key

additional properties

any

parts

Array<string>

Array of parts objects for which charge(s) the transaction was applied to

payment_method

string

The payment_method / card used

payment_method_used_token

boolean

Whether a saved payment method token was used (true) or if payment details were submitted directly with this transaction (false)

processed

string · date-time

When the transaction was processed

redirect_url

string

The URL if 3DS is required

reason

string

If action == REFUND the reason for refund

reference

string

The transaction customer facing reference (format BOLT-123445)

refunds

Array<string>

The IDs of any related refunds

refund

string

If action == REFUND a link to the refund object

refunded

string

The amount of the transaction that has been refunded

resolved

string · date-time

When the transaction was resolved

settle_currency

string

The currency the transaction was settled in if different

settle_fee_amount

string

The amount of fees deducted for processing

settle_gross_amount

string

The amount paid in the settlement currency

settle_net_amount

string

The amount settled less fees

source

string · enum

The source for the transaction

Allowed values: ECOMMERCE MOTO RECURRING POS

source_transaction

string

For refunds, references the transaction being refunded

status

string · enum

The status of the transaction:

SUCCESS - The transaction was approved
PENDING - The transaction is still in progress
DECLINED - The transaction was declined
REQAUTH - The payment requires authorization step (e.g. 3D secure)
INVALID_PAYMENT_METHOD - Invalid payment method used
UNRESOLVED - No conclusive approval/decline received
UNATTRIBUTED - Success but internal recording issue

Allowed values: SUCCESS PENDING DECLINED REQAUTH INVALID_PAYMENT_METHOD UNRESOLVED UNATTRIBUTED

sub_status

string · enum

Sub-status of the transaction, present when the gateway is waiting for someone to act:

CUSTOMER_ACTION_REQUIRED - the customer still has something to do, e.g. a bank transfer or Multibanco payment is PENDING until they make the transfer or pay the voucher
MERCHANT_ACTION_REQUIRED - reserved for future use
NO_ACTION_REQUIRED - nothing is outstanding

Omitted and NO_ACTION_REQUIRED mean the same thing - treat an absent sub_status as no action required.

Allowed values: NO_ACTION_REQUIRED CUSTOMER_ACTION_REQUIRED MERCHANT_ACTION_REQUIRED

sub_status_reason

string

e.g. "follow_bank_transfer_instructions"

Free-text description of the sub-status, e.g. follow_bank_transfer_instructions, follow_voucher_instructions or partially_funded. Descriptive only - not searchable.

target_date

string · date-time

Intended payment date. Present only when the transaction was created ahead of its target date because the payment method requires gateway advance notice (e.g. SEPA/BACS/GoCardless/Stripe ACH). This is the target date, not the settlement date, and is omitted for payment methods that charge on the due date.

updated

string · date-time

When the transaction was last updated

updated_session

string

The session the object was updated by

voided

string

The amount of the authorisation that has been voided if an AUTH

voids

Array<string>

The IDs of any related void transactions

integer

The version of the object

workflows

Array<string>

Any workflows that were applied to the payment

workflow_status

string · enum

The current status of the workflow

Allowed values: OK STOP SUSPEND

meta

object

limit

integer

offset

integer

total

integer

400

Bad request - invalid parameters

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

Unauthorized - invalid credentials

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?