Capture Checkout Session
Captures funds previously authorized on a Checkout Session whose payment intents use the
manual capture method. Capture the full authorized amount, or a partial amount by
specifying line_items and component amounts (shipping, discount, tax). By default the
remaining authorized amount stays available for further captures; set final_capture to
true to release any uncaptured remainder. For split carts the capture is allocated
across the eligible and non-eligible payment intents; use the capture allocation preview
endpoint to inspect the split first.
Authorizations
Use a Bearer token to access this API.
Path Parameters
"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
Query Parameters
Comma-separated list of related objects to expand in the response.
""
Body
An envelope wrapping a single checkout session object.
An envelope wrapping a single checkout session object.
The checkout session payload.
{
"final_capture": false,
"metadata": { "order_id": "8842", "channel": "shopify" },
"capture_metadata": { "order_id": "8842", "channel": "shopify" },
"amount_shipping": 2500,
"amount_discount": 2500,
"amount_tax": 2500
}Response
Success
An envelope wrapping a single checkout session object.
The checkout session payload.
{
"allow_promotion_codes": false,
"amount_total": 2500,
"amount_subtotal": 2500,
"amount_received": 2500,
"amount_refunded": 2500,
"amount_disputed": 2500,
"cancel_url": "https://example.com",
"captures": ["fcap_01J9XR8M3K7VZ8N2YB4WJ6T0RA"],
"disputes": ["fdp_01J9XR8M3K7VZ8N2YB4WJ6T0RA"],
"capture_method": "automatic",
"checkout_session_id": "fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"client_reference_id": "example_value",
"created_at": 2500,
"customer": "fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"defaults": {
"customer_id": "fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "+14155550142"
},
"expires_at": 2500,
"invoice": "fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"hsa_fsa_eligible": false,
"letter_of_medical_necessity_required": false,
"metadata": { "order_id": "8842", "channel": "shopify" },
"mode": "payment",
"origin": "shopify",
"payment_intent": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"redirect_url": "https://example.com",
"refunds": ["fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA"],
"setup_intent": "fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"shipping_options": {
"shipping_rate_id": "fshr_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"shipping_amount": 2500,
"display_name": "Example"
},
"shipping_address_collection": false,
"shipping_details": {
"shipping_address_id": "fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"line1": "123 Main St",
"line2": "Suite 100",
"city": "San Francisco",
"state": "CA",
"postal_code": "94107",
"country": "US"
},
"split_cart": "fsplit_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"status": "open",
"success_url": "https://example.com",
"fees": [
{
"fee_id": "ffee_1234567890",
"amount": 2500,
"name": "Example",
"description": "Premium SPF 50 mineral sunscreen",
"fee_type": "lmn_consultation"
}
],
"custom_text": {},
"subscription": "fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"subscription_data": {
"cancel_at": "2026-06-15T14:30:00Z",
"cancel_at_period_end": false
},
"tax_rate": { "amount": 2500 },
"tax_calculation_mode": "exclusive",
"test_mode": false,
"total_details": {
"amount_discount": 2500,
"amount_tax": 2500,
"amount_shipping": 2500,
"amount_iias": 2500,
"amount_vision": 2500,
"amount_prescription": 2500,
"amount_service": 2500,
"amount_fee": 2500,
"breakdown": {}
},
"visit_type": "cbtSleep",
"setup_future_use": "on_session",
"payment_method_options": {},
"next_action": {
"type": "collect_letter_of_medical_necessity"
},
"partner": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"platform_fees": { "letter_fee": {} }
}