Reversal

Action by System: Voids the Payment
Outcome: The transaction is canceled before funds leave the cardholder&#x27;s account. The pending charge is immediately released.

If you need to return funds to a shopper but aren't certain whether the original payment has been settled (captured and funded to your account) or is still only authorized, you can use the conventional reversal method.

This single API call provides an efficient way to handle both scenarios: the system automatically decides whether to perform a Void or a Refund based on the payment's current status.

How the Reversals work?

The reversal method uses a DELETE request with a force=true flag. This action triggers one of two outcomes:

Payment Status	Action/Outcome
Unsettled (Approved)	Action by System: Voids the Payment Outcome: The transaction is canceled before funds leave the cardholder's account. The pending charge is immediately released.
Settled	Action by System: Issue a Full Refund Outcome: The transaction is reversed by creating a new negative transaction that returns the full amount from your merchant account back to the cardholder.

Steps to Reverse a Payment

To use this method for a full reversal:

Make a DELETE request to the /checkout/v3/payment/{id}?force=true endpoint, including the force=true query parameter, replacing {id} with the original payment's ID
After the request, use the GET /checkout/v3/payment/{id} endpoint to check the payment's status.
The final status will be either Voided (if unsettled) or a new Refund transaction ID will be generated and associated with the original payment (if settled).

This method simplifies your integration by allowing you to use one API call to handle both pre-settlement and post-settlement reversals.