<- Object

Object

All versions ->

DeviceCheckoutOptions

Link to section

Properties

Link to section

device_id

string

Required

The unique ID of the device intended for this TerminalCheckout. A list of DeviceCode objects can be retrieved from the /v2/devices/codes endpoint. Match a DeviceCode.device_id value with device_id to get the associated device code.

Link to section

skip_receipt_screen

boolean

Instructs the device to skip the receipt screen. Defaults to false.

Link to section

collect_signature

boolean

Indicates that signature collection is desired during checkout. Defaults to false.

Link to section

tip_settings

Tip-specific settings.

Link to section

show_itemized_cart

boolean

Show the itemization screen prior to taking a payment. This field is only meaningful when the checkout includes an order ID. Defaults to true.

Link to section

allow_auto_card_surcharge

boolean

Beta

Controls whether the mobile client applies Auto Card Surcharge (ACS) during checkout. If true, ACS is applied based on Dashboard configuration. If false, ACS is not applied regardless of that configuration. For more information, see Add a Card Surcharge.