Void a payment
Last updated: September 2, 2026
After a card payment has been authorized, the payment is not complete until it has been captured. If you do not wish to capture the payment, you can void it using the void API.
Information
For American Express, Mastercard, and Visa payments, you can submit a void request on a partially captured payment to release the remaining funds back to the cardholder. If you do not request it, we'll automatically void the remainder and return it to the customer when the authorization expires.
Any void amount less than the full outstanding authorized amount is treated as a partial void.
To partially void a payment, provide an amount in your void request that's less than the outstanding authorized balance. If you do not provide an amount, we void the full outstanding amount.
Use the following endpoint to void an authorized – but not yet captured – payment.
For the full API specification, see the API reference.
Information
The Payments API supports idempotency. You can safely retry API requests without the risk of duplicate requests.
Information
Your base URL's {prefix} value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see API endpoints.
post
https://{prefix}.api.checkout.com/payments/{id}/voids
1{2"reference": "ORD-5023-4E89",3"metadata": {4"coupon_code": "NY2024",5"partner_id": 1239896}7}
If you receive a 202 Void accepted response, your void request has been accepted for processing. To get the full void response, you will need to subscribe to the payment_voided webhook.
If there was a problem with your request, you'll receive an error response such as 422 Invalid data was sent.
1{2"action_id": "act_y3oqhf46pyzuxjbcn2giaqnb44",3"reference": "ORD-5023-4E89",4"_links": {5"payment": {6"href": "https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44"7}8}9}
Information
If unsuccessful, you may also receive a 403 Void not allowed or 404 Payment not found error.