Struct TerminalReader

pub struct TerminalReader {
    pub action: Option<TerminalReaderReaderResourceReaderAction>,
    pub device_sw_version: Option<String>,
    pub device_type: TerminalReaderDeviceType,
    pub id: TerminalReaderId,
    pub ip_address: Option<String>,
    pub label: String,
    pub livemode: bool,
    pub location: Option<Expandable<TerminalLocation>>,
    pub metadata: HashMap<String, String>,
    pub serial_number: String,
    pub status: Option<TerminalReaderStatus>,
}

A Reader represents a physical device for accepting payment details.

Related guide: Connecting to a reader

For more details see <https://stripe.com/docs/api/terminal/readers/object>.

Fields

action: Option<TerminalReaderReaderResourceReaderAction>

The most recent action performed by the reader.

device_sw_version: Option<String>

The current software version of the reader.

device_type: TerminalReaderDeviceType

Type of reader, one of bbpos_wisepad3, stripe_m2, stripe_s700, bbpos_chipper2x, bbpos_wisepos_e, verifone_P400, simulated_wisepos_e, or mobile_phone_reader.

id: TerminalReaderId

Unique identifier for the object.

ip_address: Option<String>

The local IP address of the reader.

label: String

Custom label given to the reader for easier identification.

livemode: bool

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

location: Option<Expandable<TerminalLocation>>

The location identifier of the reader.

metadata: HashMap<String, String>

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.

status: Option<TerminalReaderStatus>

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

Trait Implementations

impl Clone for TerminalReader

fn clone(&self) -> TerminalReader

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TerminalReader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deserialize for TerminalReader

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for TerminalReader

fn from_value(v: Value) -> Option<Self>

impl Object for TerminalReader

type Id = TerminalReaderId

The canonical id type for this object.

fn id(&self) -> &Self::Id

The id of the object.

fn into_id(self) -> Self::Id

The owned id of the object.

impl ObjectDeser for TerminalReader

type Builder = TerminalReaderBuilder