Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Captures

Update a capture

Updates the specified capture by setting the values of the fields you pass; only metadata can be changed. Other capture fields, including captured amounts, cannot be modified.

patch/v1/captures/{capture_id}

Path parameters

capture_idstring required
Example:fcap_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Query parameters

expandstring

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

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

Request body

Example request

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

Response

An envelope wrapping a single capture object.

Example response

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