Void

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

<Note title="Note">

This operation is idempotent based on the requestId guaranteeing the payment operation is only performed once. </Note>

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 <br />Not Foundnot_foundThe orderId string provided was empty or did not match a valid order.
410 <br />Gonepayment_capturedPayment has already been fully captured for this order.
post/v2/payments/{orderId}/void

Request

  • Base URL: https://global-api-sandbox.afterpay.com
  • URL: https://global-api-sandbox.afterpay.com/v2/payments/{orderId}/void
  • Auth: HTTP basic

Path parameters

orderIdstring required

The unique ID of the Clearpay Order, returned as the id property of the Auth response.

Headers

User-Agentstring required
Acceptstring

Request body

requestIdstring

A unique request ID, required for safe retries. It is recommended that the merchant generate a UUID for each unique void.

reasonstring

Can be passed in void requests to conditionally modify wording of the corresponding consumer refund email. This can be set to 1 of 3 values, cancelledItems, amountAdjustment or null

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.