This operation is idempotent based on the
requestIdguaranteeing the payment operation is only performed once.
If successful, returns an updated copy of the Payment object.
- A new Payment Event object will be appended to the
eventsarray, with a
- A new Refund object will be prepended to the
- If the
openToCaptureamount is reduced to zero as a result of this Void request, the
paymentStatewill be updated as follows:
- from "AUTH_APPROVED" to "VOIDED", or
- from "PARTIALLY_CAPTURED" to "CAPTURED".
In addition to the PUT/POST Errors applicable to all POST endpoints, the following errors are specific to Void:
|HTTP Status Code||errorCode||Description|
|Payment has already been fully captured for this order.|
|422||The amount in USD has exceeded the open-to-capture amount in USD. Example message: "Void amount USD 999.00 exceeded open to capture amount USD 40.00"|