Refund a contract

POSThttps://app.shuttleglobal.com/c/api/instances/{instance_key}/contracts/{contract_id}/refund

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

contract_idrequired

Body application/json

cURL request

curl --request POST \
  --url https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/contracts/CONTRACT_ID/refund \
  --header 'Authorization: Basic <base64 of SECRET_KEY:>' \
  --header 'Content-Type: application/json' \
  --data '{
  "refund": {
    "amount": "15.00",
    "reason": "Subscription cancelled",
    "manual": false,
    "validate_only": false
  }
}'

const url = 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/contracts/CONTRACT_ID/refund';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <base64 of SECRET_KEY:>',
    'Content-Type': 'application/json'
  },
  body: '{"refund":{"amount":"15.00","reason":"Subscription cancelled","manual":false,"validate_only":false}}'
};

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/contracts/CONTRACT_ID/refund"

payload = { "refund": {
        "amount": "15.00",
        "reason": "Subscription cancelled",
        "manual": False,
        "validate_only": False
    } }
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/contracts/CONTRACT_ID/refund', [
  'body' => '{
  "refund": {
    "amount": "15.00",
    "reason": "Subscription cancelled",
    "manual": false,
    "validate_only": false
  }
}',
  '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/contracts/CONTRACT_ID/refund")

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  \"refund\": {\n    \"amount\": \"15.00\",\n    \"reason\": \"Subscription cancelled\",\n    \"manual\": false,\n    \"validate_only\": false\n  }\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/contracts/CONTRACT_ID/refund"

  payload := strings.NewReader("{\n  \"refund\": {\n    \"amount\": \"15.00\",\n    \"reason\": \"Subscription cancelled\",\n    \"manual\": false,\n    \"validate_only\": false\n  }\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/contracts/CONTRACT_ID/refund \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "refund": {
    "amount": "15.00",
    "reason": "Subscription cancelled",
    "manual": false,
    "validate_only": false
  }
}'

const url = 'https://app.shuttleglobal.com/c/api/contracts/CONTRACT_ID/refund';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer YOUR_ACCESS_TOKEN', 'Content-Type': 'application/json'},
  body: '{"refund":{"amount":"15.00","reason":"Subscription cancelled","manual":false,"validate_only":false}}'
};

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/contracts/CONTRACT_ID/refund"

payload = { "refund": {
        "amount": "15.00",
        "reason": "Subscription cancelled",
        "manual": False,
        "validate_only": False
    } }
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/contracts/CONTRACT_ID/refund', [
  'body' => '{
  "refund": {
    "amount": "15.00",
    "reason": "Subscription cancelled",
    "manual": false,
    "validate_only": false
  }
}',
  '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/contracts/CONTRACT_ID/refund")

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  \"refund\": {\n    \"amount\": \"15.00\",\n    \"reason\": \"Subscription cancelled\",\n    \"manual\": false,\n    \"validate_only\": false\n  }\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/contracts/CONTRACT_ID/refund"

  payload := strings.NewReader("{\n  \"refund\": {\n    \"amount\": \"15.00\",\n    \"reason\": \"Subscription cancelled\",\n    \"manual\": false,\n    \"validate_only\": false\n  }\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

Refund processed

{
  "refund_candidates": [
    {
      "source_transaction": "tr_11842_11072",
      "amount": 10
    }
  ]
}

POST

/contracts/{contract_id}/refund

You can refund a contract, which allows you to refund multiple transactions at once for recurring payments / subscriptions.

Authorizations

basicAuth
bearerAuth

Parameters

Path Parameters

contract_id

required

string

The contract’s ID (co_...), or the alt_key you gave it.

Request Body^required

application/json

object

refund

object

amount

string

e.g. "15.00"

(Optional) The amount of the refund as a string e.g., “10”. The amount should not have commas and use a . as a decimal separator. If omitted, the entire unrefunded amount of the contract will be refunded.

legal_entities

Array<object>

(Optional - enterprise) This field is an ALTERNATIVE to amount. For contracts splitting payments into multiple entities, this allows you to specify which legal_entities are refunded.

object

code

required

string

The code of the legal entity.

amount

string

(Optional) The amount to refund. If omitted, all transactions for this entity will be refunded.

reason

string

e.g. "Subscription cancelled"

(Optional) The reason for the refund (free text)

manual

boolean

(Optional) Set to true if you do not want to process the refund via the gateway, but simply record that a refund was performed offline.

validate_only

boolean

(Optional) Set to true if you do not want to perform the refund, just check to see what would be refunded.

Responses

200

Refund processed

application/json

One of:

object
object

object

refund_candidates

Array<object>

A list of candidate refunds to be taken if instructed.

object

source_transaction

string

e.g. "tr_11842_11072"

The transaction to be refunded.

amount

number

e.g. 10

The amount to be refunded from this transaction.

object

status

string · enum

SUCCESS if all refunds completed successfully, PENDING if any of the refunds is in progress, DECLINED if any of the refunds failed

Allowed values: SUCCESS PENDING DECLINED

refunds

Array<object>

A list of refunds taken.

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

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?

Refund a contract

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

400

401

Request Body^required