Mayson Monorepo Documentation
    Preparing search index...

    A Reader represents a physical device for accepting payment details.

    Related guide: Connecting to a reader

    interface Reader {
        id: string;
        object: "terminal.reader";
        action: Stripe.Terminal.Reader.Action;
        deleted?: void;
        device_sw_version: string;
        device_type: Stripe.Terminal.Reader.DeviceType;
        ip_address: string;
        label: string;
        last_seen_at: number;
        livemode: boolean;
        location: string | Stripe.Terminal.Location;
        metadata: Metadata;
        serial_number: string;
        status: Stripe.Terminal.Reader.Status;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "terminal.reader"

    String representing the object's type. Objects of the same type share the same value.

    The most recent action performed by the reader.

    deleted?: void

    Always true for a deleted object

    device_sw_version: string

    The current software version of the reader.

    Device type of the reader.

    ip_address: string

    The local IP address of the reader.

    label: string

    Custom label given to the reader for easier identification.

    last_seen_at: number

    The last time this reader reported to Stripe backend. Timestamp is measured in milliseconds since the Unix epoch. Unlike most other Stripe timestamp fields which use seconds, this field uses milliseconds.

    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    location: string | Stripe.Terminal.Location

    The location identifier of the reader.

    metadata: Metadata

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    serial_number: string

    Serial number of the reader.

    The networking status of the reader. We do not recommend using this field in flows that may block taking payments.