Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Captures

List captures

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

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

checkout_sessionstring nullable

Filter captures by checkout session ID.

Example:fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter captures by checkout session ID.

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": [],
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "test_mode": false
    }
  ]
}