Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
DEVICE

Display an order

Displays the order screen on the idle terminal. The values passed in this request are used as is. They are not used in any calculations, updating of existing order. This is strictly a UI request that shows a helpful screen to customers to show them what they are purchasing before starting a payment request.

post/v1/device/display-order

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

amountRemainingstring

If a previous payment has been made then there could be a remaining amount that the customer still owes. For this to be displayed there must be at least one DisplayPayment in the payments array. The provided amounts are not calculated in anyway and must be passed exactly as intended to be displayed.

serviceChargeAmountstring

An additional charge applied to the order for extra services provided.

serviceChargeNamestring

Descriptive title that informs the customer of what extra services are included in the order.

subtotalstring

The total before tax, surcharges, order discounts and other things are included.

taxstring

An amount of the order that will be ear marked for paying government taxes.

totalstring

The sum of all line items, amounts, discounts, taxes, surcharges and anything else.

Example request

{
  "discounts": [
    {
      "amount": "10%",
      "name": "Student"
    }
  ],
  "lineItems": [
    {
      "name": "Item 1",
      "price": "$1.00"
    },
    {
      "name": "Item 2",
      "price": "$2.00"
    }
  ],
  "subtotal": "$2.70",
  "tax": "$0.18",
  "total": "$2.88"
}

Response

The display order screen was displayed to the customer.

object required