Skip to main content
PATCH
/
v1
/
captures
/
{capture_id}
Update a capture
curl --request PATCH \
  --url https://api.withflex.com/v1/captures/{capture_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "capture": {
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    }
  }
}
'
import requests

url = "https://api.withflex.com/v1/captures/{capture_id}"

payload = { "capture": { "metadata": {
"order_id": "8842",
"channel": "shopify"
} } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({capture: {metadata: {order_id: '8842', channel: 'shopify'}}})
};

fetch('https://api.withflex.com/v1/captures/{capture_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withflex.com/v1/captures/{capture_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'capture' => [
'metadata' => [
'order_id' => '8842',
'channel' => 'shopify'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.withflex.com/v1/captures/{capture_id}"

payload := strings.NewReader("{\n \"capture\": {\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n }\n }\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.withflex.com/v1/captures/{capture_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"capture\": {\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.withflex.com/v1/captures/{capture_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"capture\": {\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n }\n }\n}"

response = http.request(request)
puts response.read_body
{
  "capture": {
    "amount_captured": 2500,
    "amount_shipping_captured": 2500,
    "amount_discount_captured": 2500,
    "amount_tax_captured": 2500,
    "capture_id": "fcap_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "created_at": "2026-06-15T14:30:00Z",
    "items": [
      {}
    ],
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "test_mode": false
  }
}
{
"code": "string",
"detail": "string"
}
{
"code": "string",
"detail": "string"
}
{
"code": "string",
"detail": "string"
}
{
"code": "string",
"detail": "string"
}
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}
{
"code": "string",
"detail": "string"
}

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Path Parameters

capture_id
string
required
Example:

"fcap_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

Query Parameters

expand
string
default:""

Comma-separated list of related objects to expand in the response (e.g., "payment_intent").

Example:

""

Body

application/json

An envelope wrapping a single capture object.

An envelope wrapping a single capture object.

capture
object
required

The capture object.

Example:
{
"metadata": { "order_id": "8842", "channel": "shopify" }
}

Response

Success

An envelope wrapping a single capture object.

capture
object
required

The capture object.

Example:
{
"amount_captured": 2500,
"amount_shipping_captured": 2500,
"amount_discount_captured": 2500,
"amount_tax_captured": 2500,
"capture_id": "fcap_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"created_at": "2026-06-15T14:30:00Z",
"items": [
{
"amount_captured": 2500,
"capture_item_id": "fcapi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"created_at": "2026-06-15T14:30:00Z",
"payment_intent": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"test_mode": false
}
],
"metadata": { "order_id": "8842", "channel": "shopify" },
"test_mode": false
}