Captures funds from a pre-authorized transaction. This converts a pre-authorization into a completed charge.
The Capture a Pre-Authorization endpoint allows you to capture funds from a pre-authorized transaction. This is used when you've previously placed a hold on a customer's card (pre-authorization) and are ready to complete the transaction by capturing the funds.
Capturing finalizes the transaction, transferring the held funds from the customer's account to the merchant.
Usage Scenarios
Hospitality Industry: Charging a customer upon checkout after their stay.
Car Rentals: Capturing funds after the rental period ends and final charges are calculated.
E-commerce with Delayed Shipping: Capturing payment once an item is shipped.
Response Structure
| Code | Response | Reason |
|---|---|---|
| 200 | Success | Returns a transaction object representing the captured funds, including transaction ID, type, status, amount, currency, original transaction ID, payment method ID, customer ID, creation timestamp, and any metadata provided. |
| 400 | Bad request | Occurs when attempting to capture more than the pre-authorized amount, or if the pre-authorization has expired or been captured already. |
| 404 | Not Found | The provided transaction_id does not correspond to a valid pre-authorization. |
| 422 | Unprocessable Entity | Validation errors, such as invalid amounts. |
Detailed Parameter Descriptions
transaction_id: Must be a valid pre-authorization transaction ID. Ensure the pre-authorization is still valid and not expired or voided.
amount: Specify if capturing a partial amount. Cannot exceed the original pre-authorization amount.
meta: Include additional information or custom data relevant to the capture transaction.
Usage Notes
Partial Captures
You can capture less than the pre-authorized amount if necessary. Remaining funds may be released or require a void operation.
Multiple Captures
Some processors allow multiple partial captures against a single pre-authorization. Verify if this is supported.
Timing
Pre-authorizations have a validity period (typically 7 days). Capture within this timeframe.
Idempotency
Use idempotency_id to prevent duplicate captures.
Additional Considerations
Remaining Funds
After a partial capture, remaining pre-authorized funds may need to be released.
Communication with Customer
Inform customers when captures occur, especially if the captured amount differs from the pre-authorized amount.
Compliance
Ensure compliance with processor policies and card network regulations regarding pre-authorizations and captures.