Void a payment

post

https://deviceIpOrHost:12346/connect/v1/payments/{paymentId}/void

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.

Path Params

paymentId

string

required

length between 13 and 13

Clover payment UUID

Body Params

voidReason

string

enum

required

Headers

X-Clover-Device-Id

string

required

The Clover device to route the request to.

X-POS-Id

string

required

An identifier for the POS making the request.

X-Clover-Timeout

integer

0 to 300

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-Key

string

required

The idempotency key transmitted during the request, if any.

Responses

Language

Credentials

Bearer

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A valid VoidResponse

209Operation was canceled.

400The request is invalid, and subsequent calls will continue to fail; do not repeat the call.

401An invalid bearer token has been provided. The call may be repeated if the provided bearer token is updated.

415The request is invalid, and contains request data in an unsupported format. This call may be repeated if the content is changed to a supported format.

500The request processing failed with an unknown error, and the processing state of the operation is indeterminate. Do not repeat the call without additional analysis.

501The device does not have the ability to respond to the requested operation; do not repeat the call.

503The device is not available because it is currently servicing another call. This can be repeated at a later time, or cancel may be called to end the current operation.

504The Device did not respond in a timely manner. This can be repeated at a later time.