Capture Controls
Manage how and when authorized funds are captured—full, partial, or above the original amount.
When a transaction is authorized, the cardholder's bank confirms that sufficient funds are available and places a hold on the amount. However, the funds aren't actually moved until a capture request is made.
Capturing an authorized transaction finalizes the payment. It instructs the system to move the held funds from the cardholder’s account into the merchant’s account. Without a capture, the authorization remains pending and will eventually expire.
By controlling when and how much to capture, businesses can align payment collection with a service completion. This flexibility helps reduce refunds and disputes, and supports operational needs like delayed fulfillment or split shipments.
There can be various capture scenarios — from capturing the full amount immediately, to splitting the capture into parts, or even delaying the capture until later. The following features allow you to tailor the capture process to your specific business model.
Types of Captures
The types of captures you can make depend on the portion of the authorization amount you choose to capture:
-
Full Capture: Capture the full amount that was originally authorized. This is the most common and straightforward capture scenario.
This is typically done when:
- The goods or services are ready for delivery or completion
- You want to settle the funds immediately post-authorization
- You have not split the authorization into multiple partial captures
-
- Single Partial Capture: Capture less than the total authorized amount in one call. You can repeat this until you’ve captured the full amount.
- Multi Capture: Useful for scenarios like e‑commerce shipments or unified commerce across channels. Each shipment or service event triggers a separate partial capture.
-
Over Capture: Capture an amount slightly higher than the initially authorized value—commonly used for tips, incidentals, or service charges. Over-capture is limited by card network rules (often up to 15–20% above auth).
a. Adjust Capture
Adjust Capture allows you to modify the previously captured transaction amount, either by increasing or decreasing it, before it is settled.
This is useful in industries where the final charge amount may change—such as hospitality, fuel, or car rental services.
Adjustments help reduce declines and improve customer experience by avoiding multiple holds on funds.
Use this when:
- The final charge differs.
- You need to reduce the held amount due to cancellations or refunds.
Note: You need to specify the entire new Auth amount and not the difference.
Steps to Adjust Capture
To Adjust a Capture:
-
Use the PUT
/checkout/v3/payment/{id}
endpoint that includes:Parameter Description ternderType
Set to CARD
for card transactions.paymentToken
Secure payment token for the authorization to be adjusted. amount
New amount (in US currency units). Can be higher or lower than the previously mentioned amount. merchantId
Merchant location ID. -
The GET
/checkout/v3/payment/{id}
endpoint gives a response with new amount.amount
: New amount as specified in the Adjust API.status
: Status of the payment. You will also receive the result in a webhook.
-
Wait for the Adjust Payment webhook to learn the outcome of the request.
You can store the id
and paymentToken
for:
- Retrieving payment details later.
- Voiding the payment (if needed).
- Issuing partial or full refunds.
b. Void Captures
Voiding captured payments will cancel the previously held funds before they are captured. This is useful when the transaction needs to be canceled due to any reason, or the final amount is not yet finalized.
Once voided, the funds are released back to the cardholder’s account based on issuer timelines.
Voiding helps avoid unnecessary holds on customer funds and improves customer experience.
Use voids when:
- A capture is no longer needed.
- You want to cancel a capture without impacting the customer's statement.
NOTE:
- Void is only possible before the capture is settled.
- If capture has already been settled, initiate a Refund instead.
Steps to Void a Capture
To Void a Caoture:
- Use the DELETE
/checkout/v3/payment/{id}
endpoint. - The GET
/checkout/v3/payment/{id}
endpoint gives a response with:status
: Status of the payment marked asVOIDED
.
- Wait for the Void Payment Webhook to learn the outcome of the request.
Once voided, the capture cannot be processed. No settlement occurs; the void transaction is final.
See Also
Navigate the sub-pages below for detailed API usage, parameters, and best practices:
- Refunds Understand how to handle partial or full refunds for payments.
Updated 11 days ago