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"
    }
  }
}
'
{
  "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
  }
}

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
}