Set reader display 

Terminal
Reader
Set reader display

Sets reader display to show cart details.

Parameters

  • typeenumRequired

    Type

  • cartobject

    Cart

    • cart.currencyenumRequired

      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • cart.line_itemsarray of objectsRequired

      Array of line items that were purchased.

      • cart.line_items.amountintegerRequired

        The price of the item in cents.

      • cart.line_items.descriptionstringRequired

        The description or name of the item.

      • cart.line_items.quantityintegerRequired

        The quantity of the line item being purchased.

    • cart.totalintegerRequired

      Total balance of cart due in cents.

    • cart.taxinteger

      The amount of tax in cents.

Returns

Returns an updated Reader resource.

POST /v1/terminal/readers/:id/set_reader_display
curl https://api.stripe.com/v1/terminal/readers/tmr_FDOt2wlRZEdpd7/set_reader_display \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-d type=cart \
-d "cart[currency]"=usd \
-d "cart[line_items][0][amount]"=5100 \
-d "cart[line_items][0][description]"="Red t-shirt" \
-d "cart[line_items][0][quantity]"=1 \
-d "cart[tax]"=100 \
-d "cart[total]"=5200
Response
{
"id": "tmr_FDOt2wlRZEdpd7",
"object": "terminal.reader",
"action": {
"failure_code": null,
"failure_message": null,
"set_reader_display": {
"cart": {
"currency": "usd",
"line_items": [
{
"amount": 5100,
"description": "Red t-shirt",
"quantity": 1
}
],
"tax": 100,
"total": 5200
},
"type": "cart"
},
"status": "in_progress",
"type": "set_reader_display"
},
"device_sw_version": "",
"device_type": "simulated_wisepos_e",
"ip_address": "0.0.0.0",
"label": "Blue Rabbit",
"last_seen_at": 1695166525506,
"livemode": false,
"location": "tml_FDOtHwxAAdIJOh",
"metadata": {},
"serial_number": "259cd19c-b902-4730-96a1-09183be6e7f7",
"status": "online"
}