Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
DEVICE

Get a tip

Displays a message on a Clover device requesting customer selection of a tip amount or percentage.

post/v1/device/read-tip

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

The idempotency key transmitted during the request, if any.

Request body

baseAmountinteger

For percentage tip suggestions, this is the amount the calculated tips will be based upon. This is an integer with 2 decimal points implied, for example 100 = 1.00

Example request

{
  "baseAmount": 23,
  "tipSuggestions": [
    {
      "name": "Best service ever!",
      "percentage": 25
    },
    {
      "name": "Really good service",
      "percentage": 20
    },
    {
      "name": "Good service",
      "percentage": 18
    },
    {
      "name": "Ok service",
      "percentage": 15
    },
    {
      "amount": 200,
      "name": "Two Dollars"
    },
    {
      "name": "Two Fifty",
      "percentage": 250
    }
  ]
}

Response

The tip screen was displayed to the customer.

responseinteger

Example response

{
  "response": 100
}