Get a capture

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

capture_idrequired

Query

expand

cURL request

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

const url = 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/captures/CAPTURE_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/captures/CAPTURE_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/captures/CAPTURE_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/captures/CAPTURE_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/captures/CAPTURE_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/captures/CAPTURE_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/captures/CAPTURE_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/captures/CAPTURE_ID', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
  ],
]);

echo $response->getBody();

require 'uri'
require 'net/http'

url = URI("https://app.shuttleglobal.com/c/api/captures/CAPTURE_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/captures/CAPTURE_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

Capture details

{
  "capture": {
    "id": "string",
    "account": "string",
    "amount": "string",
    "balance": "string",
    "created": "2026-01-01T12:00:00Z",
    "created_session": "string",
    "currency": "string",
    "gateway_message": "string",
    "gateway_reference": "string",
    "gateway_status": "string",
    "metadata": {},
    "offline": true,
    "parts": [
      "string"
    ],
    "payment": "string",
    "processed": "2026-01-01T12:00:00Z",
    "reference": "string",
    "refunded": "string",
    "settle_currency": "string",
    "settle_fee_amount": "string",
    "settle_gross_amount": "string",
    "settle_net_amount": "string",
    "source_transaction": "string",
    "status": "SUCCESS",
    "updated": "2026-01-01T12:00:00Z",
    "updated_session": "string",
    "v": 0
  }
}

GET

/captures/{capture_id}

Retrieve details of a specific capture transaction.

You can expand the following fields:

account
created_session
parts
source_transaction
updated_session

Authorizations

basicAuth
bearerAuth

Parameters

Path Parameters

capture_id

required

string

Pattern /^ca_[0-9]+_[0-9a-z]+$/

The capture’s ID (ca_...).

Query Parameters

expand

string

Fields to expand into full objects

Responses

200

Capture details

application/json

object

capture

object

A capture transaction representing the settlement of a previously authorised payment

object

string

The ID of the capture

Pattern /^ca_[0-9]+_[0-9a-z]+$/

account

string

The account the capture was for

amount

string

The amount captured

balance

string

The capture amount less any refunds

created

string · date-time

When the capture was created

created_session

string

The session that created the capture

currency

string

The currency in ISO format

gateway_message

string

The status message returned by the gateway

gateway_reference

string

The gateway identifier for the capture

gateway_status

string

The category or error message received from the gateway

metadata

object

Custom key-value pairs stored on the capture

object

key

additional properties

any

offline

boolean

Whether this capture was recorded as an offline transaction

parts

Array<string>

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

payment

string

The original payment (AUTH) this capture relates to

processed

string · date-time

When the capture was processed by the gateway

reference

string

The customer-facing reference (format BOLT-*)

refunded

string

The amount of the capture that has been refunded

settle_currency

string

The currency the capture 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_transaction

string

The original AUTH transaction that was captured

status

string · enum

The status of the capture

Allowed values: SUCCESS PENDING DECLINED INVALID_PAYMENT_METHOD UNRESOLVED UNATTRIBUTED

updated

string · date-time

When the capture was last updated

updated_session

string

The session that last updated the capture

integer

The version of the record

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

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

Capture 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?