This endpoint voids the remaining openToCapture amount of the payment auth, and refunds the consumer.

📘

Note

This operation is idempotent based on the requestId guaranteeing the payment operation is only performed once.

Successful Response (201)

If successful, returns an updated copy of the Payment object.

  • A new Payment Event object will be appended to the events array, with a type of "VOIDED".
  • A new Refund object will be prepended to the refunds array.
  • If the openToCapture amount is reduced to zero as a result of this Void request, the paymentState will be updated as follows:
    • from "AUTH_APPROVED" to "VOIDED", or
    • from "PARTIALLY_CAPTURED" to "CAPTURED".

Connection Timeouts

TimeoutTime (Seconds)
Open10
Read70

Errors

In addition to the PUT/POST Errors applicable to all POST endpoints, the following errors are specific to Void:

HTTP Status CodeerrorCodeDescription
404
Not Found
not_foundThe orderId string provided was empty or did not match a valid order.
410
Gone
payment_capturedPayment has already been fully captured for this order.
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!