WIwithflex
Captures

List captures

Changed on

Returns a list of your captures. Optionally filter to a single checkout session with the checkout_session query parameter, and expand related objects (such as the payment intent) with expand.

get/v1/captures

Request

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

Query parameters

expandstring

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

checkout_sessionstring nullable

Filter captures by checkout session ID.

Example:fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Response

An envelope wrapping a list of capture objects.

Example response

{
  "captures": [
    {
      "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