Capture a payment

POSThttps://app.shuttleglobal.com/c/api/instances/{instance_key}/payments/{payment_id}/capture

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

payment_idrequired

Body application/json

cURL request

curl --request POST \
  --url https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/payments/PAYMENT_ID/capture \
  --header 'Authorization: Basic <base64 of SECRET_KEY:>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "50.00",
  "description": "Partial capture for shipped items"
}'

const url = 'https://app.shuttleglobal.com/c/api/instances/YOUR_INSTANCE_KEY/payments/PAYMENT_ID/capture';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <base64 of SECRET_KEY:>',
    'Content-Type': 'application/json'
  },
  body: '{"amount":"50.00","description":"Partial capture for shipped items"}'
};

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/payments/PAYMENT_ID/capture"

payload = {
    "amount": "50.00",
    "description": "Partial capture for shipped items"
}
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/payments/PAYMENT_ID/capture', [
  'body' => '{
  "amount": "50.00",
  "description": "Partial capture for shipped items"
}',
  '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/payments/PAYMENT_ID/capture")

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  \"amount\": \"50.00\",\n  \"description\": \"Partial capture for shipped items\"\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/payments/PAYMENT_ID/capture"

  payload := strings.NewReader("{\n  \"amount\": \"50.00\",\n  \"description\": \"Partial capture for shipped items\"\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/payments/PAYMENT_ID/capture \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "50.00",
  "description": "Partial capture for shipped items"
}'

const url = 'https://app.shuttleglobal.com/c/api/payments/PAYMENT_ID/capture';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer YOUR_ACCESS_TOKEN', 'Content-Type': 'application/json'},
  body: '{"amount":"50.00","description":"Partial capture for shipped items"}'
};

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/payments/PAYMENT_ID/capture"

payload = {
    "amount": "50.00",
    "description": "Partial capture for shipped items"
}
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/payments/PAYMENT_ID/capture', [
  'body' => '{
  "amount": "50.00",
  "description": "Partial capture for shipped items"
}',
  '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/payments/PAYMENT_ID/capture")

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  \"amount\": \"50.00\",\n  \"description\": \"Partial capture for shipped items\"\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/payments/PAYMENT_ID/capture"

  payload := strings.NewReader("{\n  \"amount\": \"50.00\",\n  \"description\": \"Partial capture for shipped items\"\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

Capture processed

{
  "capture": {
    "id": "ca_11842_10006",
    "payment": "pay_11842_10005",
    "amount": "20",
    "status": "SUCCESS",
    "reference": "REF-00010006",
    "gateway_reference": "ch_1GVaKJFi2CnH4uN3AmXTKHwB",
    "gateway_status": "APPROVED",
    "source_transaction": "tr_11842_10005",
    "created": "2020-04-08T09:36:19.000Z",
    "processed": "2020-04-08T09:36:20.000Z"
  }
}

POST

/payments/{payment_id}/capture

Capture funds for a previously authorized payment. You must have created a payment with action=AUTH first.

You can capture the full authorized amount or a partial amount. Multiple partial captures are supported on some gateways, up to the total authorized amount.

Authorizations

basicAuth
bearerAuth

Parameters

Path Parameters

payment_id

required

string

The authorisation’s payment ID (pay_...) or transaction ID (tr_...), or the alt_key you gave it (case-insensitive). The record must be an authorisation, otherwise 404 Payment not found. An alt_key resolves to the newest authorisation with an amount still open, ignoring failed attempts.

Request Body^required

application/json

object

amount

string

e.g. "50.00"

Amount to capture. If not specified, the full authorization amount will be captured.

description

string

e.g. "Partial capture for shipped items"

Optional description for the capture

Responses

200

Capture processed

application/json

object

capture

object

string

e.g. "ca_11842_10006"

Capture identifier

payment

string

e.g. "pay_11842_10005"

Payment ID this capture is associated with

amount

string

e.g. "20"

Amount that was captured

status

string · enum

e.g. "SUCCESS"

Status of the capture operation

Allowed values: SUCCESS PENDING DECLINED

reference

string

e.g. "REF-00010006"

Reference for the capture

gateway_reference

string

e.g. "ch_1GVaKJFi2CnH4uN3AmXTKHwB"

Reference from the payment gateway

gateway_status

string

e.g. "APPROVED"

Status reported by the gateway

source_transaction

string

e.g. "tr_11842_10005"

The original transaction that was captured

created

string · date-time

e.g. "2020-04-08T09:36:19.000Z"

When the capture was created

processed

string · date-time

e.g. "2020-04-08T09:36:20.000Z"

When the capture was processed

400

Bad request - invalid capture 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

Payment not found or not eligible for capture

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?

Capture a payment

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

400

401

404

Request Body^required