Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
CREDITS

Void a payment

Cancels the specified payment before it is settled. The payment will be recorded as a void, but Clover may convert the void into a refund at the payment gateway under certain conditions. For final payments (where the final flag is set to true), a void cannot be processed outside of the settlement window (more than 25 minutes after the payment). When a void is not possible, Clover performs a refund instead of a void.

post/v1/payments/{paymentId}/void

Path parameters

paymentIdstring required

Clover payment UUID

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

X-Clover-Device-Idstring required

The Clover device to route the request to.

X-POS-Idstring required

An identifier for the POS making the request.

X-Clover-Timeoutinteger

The amount of time, in seconds, that this operation will process before timing out. A value of 0 indicates no timeout will be enforced by Remote Pay, although protocol specified timeouts may still apply.

Idempotency-Keystring required

The idempotency key transmitted during the request, if any.

Request body

voidReason'USER_CANCEL' | 'TRANSPORT_ERROR' | 'REJECT_SIGNATURE' | 'REJECT_PARTIAL_AUTH' | 'NOT_APPROVED' | 'FAILED' | 'AUTH_CLOSED_NEW_CARD' | 'DEVELOPER_PAY_PARTIAL_AUTH' | 'REJECT_DUPLICATE' | 'REJECT_OFFLINE' | 'GIFTCARD_LOAD_FAILED' | 'USER_GIFTCARD_LOAD_CANCEL' | 'DEVELOPER_PAY_TIP_ADJUST_FAILED' | 'USER_CUSTOMER_CANCEL' | 'FRAUD' required

Response

A valid VoidResponse

Example response

{
  "payment": {
    "cardTransaction": {
      "last4": "1234"
    },
    "refunds": [
      {
        "cardTransaction": {
          "last4": "1234"
        }
      }
    ]
  }
}