Capture Adjustment
Adjust a previously captured card payment amount before settlement.
Capture adjustment lets you modify the amount on a previously captured card transaction before it’s settled. This is useful when the final charge changes after capture, like in hospitality, fuel, or car rental scenarios.
By adjusting the capture instead of creating new transactions, you can reduce declines and avoid multiple holds on the cardholder’s funds, improving the overall customer experience.
Prerequisites and Limitations
- Prerequisites: You must have a valid
idandpaymentTokenfor an existing captured card payment, and your merchant account must support capture adjustments. - Limitations: You can only adjust a payment before settlement. The new amount must respect issuer and processor rules for that card and currency.
When to Use Capture Adjustment
Use capture adjustment when:
- The final charge differs from the amount you originally captured.
- Additional services or fees are added after the capture.
- You need to reduce the captured amount due to partial cancellations or order changes.
Note: You need to specify the entire new capture amount—not just the difference.
Adjust a Capture via API
To adjust a capture:
-
Call the PUT
/checkout/v3/payment/{id}with a request body that includes:Parameter Description tenderTypeSet to CARDfor card transactions.paymentTokenSecure payment token for the payment you want to adjust. amountNew total amount (in US currency units). Can be higher or lower than the previously captured sum. merchantIdMerchant location ID. -
Use the GET
/checkout/v3/payment/{id}endpoint to confirm the updated capture. The response includes:amount: New amount as specified in the adjust request.status: Current status of the payment. You’ll also receive the result in a webhook.
-
Monitor the Adjust Payment webhook to track the final outcome of the capture adjustment.
You can store the id and paymentToken to:
- Retrieve updated payment details later.
- Void the payment, if needed.
- Issue partial or full refunds.
Updated 3 days ago