WIwithflex
Captures

Update a capture

Changed on

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}

Request

  • Base URL
    https://api.withflex.com
  • URL
    https://api.withflex.com/v1/captures/{capture_id}
  • Auth
    HTTP bearer

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").

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": [
      {
        "amount_captured": 2500,
        "capture_item_id": "fcapi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
        "created_at": "2026-06-15T14:30:00Z",
        "price": "fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
        "payment_intent": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
        "test_mode": false
      }
    ],
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "test_mode": false
  }
}

Changes

  • eec642897a22Revision changes
    • warning

      added the new adaptiveShoesDependent enum value to the ///////////////////// response property for the response status

    • warning

      added the new automatedCleaner enum value to the ///////////////////// response property for the response status

    • warning

      added the new babyMonitorSplit enum value to the ///////////////////// response property for the response status

    • warning

      added the new babySleepApp enum value to the ///////////////////// response property for the response status

    • warning

      added the new bodyPillow enum value to the ///////////////////// response property for the response status

    • warning

      added the new breathWorkDependent enum value to the ///////////////////// response property for the response status

    • warning

      added the new coolingSleepwear enum value to the ///////////////////// response property for the response status

    • warning

      added the new meneralsNootropicPouch enum value to the ///////////////////// response property for the response status

    • warning

      added the new nonenalOdor enum value to the ///////////////////// response property for the response status

    • warning

      added the new nursingChairs enum value to the ///////////////////// response property for the response status

    • warning

      added the new speechHealthDependent enum value to the ///////////////////// response property for the response status

    • warning

      added the new uvClothing enum value to the ///////////////////// response property for the response status

    • warning

      added the new uvGlasses enum value to the ///////////////////// response property for the response status

    • info

      added the optional property //////////// to the response with the status