Display an order

post

https://deviceIpOrHost:12346/connect/v1/device/display-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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amountRemaining

string

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.

discounts

array of objects

An array of discounts that lower the cost of the order.

discounts

lineItems

array of objects

An array of individual items that make up the order.

lineItems

payments

array of objects

An array of processed payments already applied to the order.

payments

serviceChargeAmount

string

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

serviceChargeName

string

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

subtotal

string

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

tax

string

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

total

string

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

Headers

User-Agent

string

required

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

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.

Responses

200The display order screen was displayed to the customer.

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.