Get a refund

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

refund_idrequired

Query

expand

cURL request

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

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

echo $response->getBody();

require 'uri'
require 'net/http'

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

Refund details

{
  "refund": {
    "id": "ref_11842_11073",
    "payment": "pay_11842_11072",
    "amount": "10",
    "created": "2020-11-27T15:17:15.000Z",
    "processed": "2020-11-27T15:17:18.000Z",
    "reason": "Customer requested cancellation",
    "reference": "BOLT-00011073",
    "source_transaction": "tr_11842_11072",
    "status": "SUCCESS",
    "gateway_status": "APPROVED",
    "gateway_message": "string",
    "manual": false,
    "currency": "USD",
    "account": "string",
    "parts": [
      {}
    ],
    "offline": false,
    "updated": "2026-01-01T12:00:00Z",
    "v": 0
  }
}

GET

/refunds/{refund_id}

Retrieve details of a specific refund. You can expand additional related objects using the expand parameter.

Available expand options:

account
created_session
parts
source_transaction
updated_session

Authorizations

basicAuth
bearerAuth

Parameters

Path Parameters

refund_id

required

string

The refund’s ID (ref_...).

Query Parameters

expand

string

Related objects to include in the response

Responses

200

Refund details

application/json

object

refund

object

string

e.g. "ref_11842_11073"

The unique ID of the refund

payment

string

e.g. "pay_11842_11072"

The original payment this refund relates to

amount

string

e.g. "10"

The amount refunded

created

string · date-time

e.g. "2020-11-27T15:17:15.000Z"

When the refund was created/instructed

processed

string · date-time

e.g. "2020-11-27T15:17:18.000Z"

When the refund completed processing

reason

string

e.g. "Customer requested cancellation"

The reason for the refund

reference

string

e.g. "BOLT-00011073"

A unique customer facing reference for the refund

source_transaction

string

e.g. "tr_11842_11072"

The original transaction that is being refunded - may be a payment or a capture

status

string · enum

The status of the refund transaction

Allowed values: SUCCESS PENDING DECLINED INVALID_PAYMENT_METHOD UNRESOLVED UNATTRIBUTED

gateway_status

string · enum

The gateway status of the refund transaction

Allowed values: APPROVED PENDING DECLINED DECLINED_ERROR UNRESOLVED MANUAL

gateway_message

string

The message from the gateway (if pending or declined)

manual

boolean

False if the refund was instructed, or true if it was only recorded (in which case the onus is on the user to perform the refund via an offline method)

currency

string

e.g. "USD"

The currency of the refund (always the same as source transaction)

account

string

The ID of the person this refund is for

parts

Array<object>

An array of parts objects for which charge(s) the refund was applied to

object

offline

boolean

True if this is just a record to indicate a refund was performed offline

updated

string · date-time

The date the record was last updated

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

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