v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

DEVICE

Opens the specified cash drawer

Sends a signal to open the specified cash drawer attached to a Clover device.

post/v1/device/cash-drawer/open

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.

Request body

cashDrawerIdstring

An id obtained from the list of ids in the retrieve cash drawers call, or null for default.

reasonstring

The reason for opening the cash drawer

Response

A response from a Clover device indicating whether or not the cash drawer may have opened.

cashDrawerIdstring

The id of the cash drawer that was signaled to open. Note that a successful response actually indicates that the the cash drawer likely opened, but could have failed due to mechanical/electrical issues or because that cash drawer is not actually connected, or it may simply be locked.