> For the complete documentation index, see [llms.txt](https://docs.hyperswitch.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperswitch.io/integrations/prism/python/payment-service/capture.md).

# Capture

## Overview

The `capture` method finalizes an authorized payment by transferring the reserved funds from the customer's account to your merchant account. This completes the payment lifecycle after a successful authorization.

**Business Use Case:** An e-commerce order has shipped. The customer's payment was authorized at checkout, and now that the order is on its way, you capture the funds to complete the transaction.

## Purpose

**Why use capture?**

| Scenario                   | Benefit                                |
| -------------------------- | -------------------------------------- |
| **E-commerce fulfillment** | Charge customers only when orders ship |
| **Hotel checkout**         | Capture final bill amount at check-out |
| **Service completion**     | Bill after service is rendered         |
| **Partial shipments**      | Capture only what was actually shipped |

**Key outcomes:**

* Funds transfer from customer to merchant
* Payment reaches CAPTURED status
* Transaction proceeds to settlement

## Request Fields

| Field                      | Type   | Required | Description                                   |
| -------------------------- | ------ | -------- | --------------------------------------------- |
| `merchant_transaction_id`  | string | Yes      | Your unique transaction reference             |
| `connector_transaction_id` | string | Yes      | The connector's transaction ID from authorize |
| `amount`                   | Money  | No       | Amount to capture (can be partial)            |
| `description`              | string | No       | Description for customer's statement          |
| `metadata`                 | dict   | No       | Additional data (max 20 keys)                 |

## Response Fields

| Field                      | Type          | Description                               |
| -------------------------- | ------------- | ----------------------------------------- |
| `merchant_transaction_id`  | string        | Your transaction reference (echoed back)  |
| `connector_transaction_id` | string        | Connector's transaction ID                |
| `status`                   | PaymentStatus | Current status: CAPTURED, PENDING, FAILED |
| `captured_amount`          | int64         | Amount captured in minor units            |
| `error`                    | ErrorInfo     | Error details if status is FAILED         |
| `status_code`              | int           | HTTP-style status code (200, 402, etc.)   |

## Example

### SDK Setup

```python
from hyperswitch_prism import PaymentClient

payment_client = PaymentClient(
    connector='stripe',
    api_key='YOUR_API_KEY',
    environment='SANDBOX'
)
```

### Request

```python
request = {
    "merchant_transaction_id": "txn_order_001",
    "connector_transaction_id": "pi_3Oxxx...",
    "amount": {
        "minor_amount": 1000,
        "currency": "USD"
    },
    "description": "Order shipment #12345"
}

response = await payment_client.capture(request)
```

### Response

```python
{
    "merchant_transaction_id": "txn_order_001",
    "connector_transaction_id": "pi_3Oxxx...",
    "status": "CAPTURED",
    "captured_amount": 1000,
    "status_code": 200
}
```

## Common Patterns

### Two-Step Payment Flow

```mermaid
sequenceDiagram
    participant App as Your App
    participant CS as Prism
    participant PP as Payment Provider

    Note over App: Customer places order
    App->>CS: 1. authorize payment
    CS->>PP: Reserve funds
    PP-->>CS: Return: AUTHORIZED
    CS-->>App: Confirm authorization
    Note over App: Order ships
    App->>CS: 2. capture payment
    CS->>PP: Transfer funds
    PP-->>CS: Return: CAPTURED
    CS-->>App: Confirm capture
```

**Flow Explanation:**

1. **Authorize** - Reserve funds at checkout to verify payment method.
2. **Fulfill** - Process and ship the order.
3. **Capture** - Transfer funds when order ships.

## Partial Capture

Capture less than the authorized amount:

```python
# Authorized for $100, capture only $75
request = {
    "merchant_transaction_id": "txn_order_001",
    "connector_transaction_id": "pi_3Oxxx...",
    "amount": {
        "minor_amount": 7500,  # $75.00
        "currency": "USD"
    }
}
```

The remaining $25 is automatically released back to the customer.

## Error Handling

| Error Code | Meaning               | Action                                      |
| ---------- | --------------------- | ------------------------------------------- |
| `402`      | Capture failed        | Authorization expired or insufficient funds |
| `404`      | Transaction not found | Verify connector\_transaction\_id           |
| `409`      | Already captured      | Idempotent - already captured successfully  |

## Next Steps

* [authorize](/integrations/prism/python/payment-service/authorize.md) - Create initial authorization
* [void](/integrations/prism/python/payment-service/void.md) - Cancel authorization instead of capturing
* [refund](/integrations/prism/python/payment-service/refund.md) - Return funds after capture


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.hyperswitch.io/integrations/prism/python/payment-service/capture.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.