Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Set reader display 

Sets reader display to show cart details.

Parameters

  • typeenumRequired

    Type

  • cartobject

    Cart

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"
}

Simulate presenting a payment method Test helper

Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.

Parameters

  • card_presentobject

    Simulated data for the card_present payment method.

  • typeenum

    Simulated payment type.

    Possible enum values
    card

    Simulate a card payment method

    card_present

    Simulate a card_present payment method

    interac_present

    Simulate a interac_present payment method

More parameters

  • amount_tipinteger

  • cardobject

  • interac_presentobject

Returns

Returns an updated Reader resource.

POST /v1/test_helpers/terminal/readers/:id/present_payment_method
curl -X POST https://api.stripe.com/v1/test_helpers/terminal/readers/tmr_gLeqlF03xvlBympS9RfZqdpF/present_payment_method \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "id": "tmr_gLeqlF03xvlBympS9RfZqdpF",
  "object": "terminal.reader",
  "action": {
    "failure_code": null,
    "failure_message": null,
    "process_payment_intent": {
      "payment_intent": "pi_1Gt0582eZvKYlo2CGSidzWqK"
    },
    "status": "succeeded",
    "type": "process_payment_intent"
  },
  "device_sw_version": null,
  "device_type": "bbpos_wisepos_e",
  "ip_address": "192.168.2.2",
  "label": "Blue Rabbit",
  "last_seen_at": null,
  "livemode": false,
  "location": null,
  "metadata": {},
  "serial_number": "123-456-789",
  "status": "online"
}

Terminal Hardware Order Preview

A TerminalHardwareOrder represents an order for Terminal hardware, containing information such as the price, shipping information and the items ordered.

Endpoints

Terminal Hardware Product Preview

A TerminalHardwareProduct is a category of hardware devices that are generally similar, but may have variations depending on the country it’s shipped to.

TerminalHardwareSKUs represent variations within the same Product (for example, a country specific device). For example, WisePOS E is a TerminalHardwareProduct and a WisePOS E - US and WisePOS E - UK are TerminalHardwareSKUs.

Endpoints

Terminal Hardware SKU Preview

A TerminalHardwareSKU represents a SKU for Terminal hardware. A SKU is a representation of a product available for purchase, containing information such as the name, price, and images.

Endpoints